Diese Präsentation wurde erfolgreich gemeldet.
Wir verwenden Ihre LinkedIn Profilangaben und Informationen zu Ihren Aktivitäten, um Anzeigen zu personalisieren und Ihnen relevantere Inhalte anzuzeigen. Sie können Ihre Anzeigeneinstellungen jederzeit ändern.
JSDoc ToolKit~ javascript documentation ~                           2011/12/26                  h13i32maru@Twitter        ...
自己紹介• 丸山 亮(h13i32maru) 最近はJSを触ってます• KLab株式会社所属32   http://blog.h13i32maru.jp     http://twitter.com/h13i32maru     https:/...
ドキュメント大事ですよね
でも書くのは面倒(´・ω・`)
じゃあせめてクラス・メソッドのリファレンスは書こう(・∀・)
Hoge Doc•   Java Docに代表されるHoge Docって結構ある    •   Java Doc    •   PHP Documenter    •   Py Doc    •   RDoc
JSDoc ToolKit•   Javascript用ドキュメントツール•   JSDocの後継•   @hoge foo barスタイルのJava Doc風
/** * @class /ALLIANCE/作成 * @author <a href="mailto:sano-n@klab.jp">Naohide Sano</a> (sano-n) * @extends KNGP.GLPage */var...
アノテーション•   動的言語ならではのアノテーション    •   @extends    •   @lends    •   @constructor    •   @class, @function, @field    •   @priv...
独自アノテーションも追加したいな(´・ω・`)
プラグイン•   Javascriptでプラグインも簡単に作れる•   ドキュメント生成時の各ライフサイクルをフック
JSDOC.PluginManager.registerPlugin(	 "JSDOC.tagSynonyms",	 {	 	    onDocCommentSrc: function(comment) {	 	    	  comment.s...
注意点•   シノニムが結構ある    •   @returns == @return    •   @constructor == @constructs    •   @augments == @extends    •   etc...
おわり
Nächste SlideShare
Wird geladen in …5
×

JSDoc ToolKit

  • Als Erste(r) kommentieren

  • Gehören Sie zu den Ersten, denen das gefällt!

JSDoc ToolKit

  1. 1. JSDoc ToolKit~ javascript documentation ~ 2011/12/26 h13i32maru@Twitter maruyama-r@KLab
  2. 2. 自己紹介• 丸山 亮(h13i32maru) 最近はJSを触ってます• KLab株式会社所属32 http://blog.h13i32maru.jp http://twitter.com/h13i32maru https://www.facebook.com/ryo.maruyama https://github.com/h13i32maru
  3. 3. ドキュメント大事ですよね
  4. 4. でも書くのは面倒(´・ω・`)
  5. 5. じゃあせめてクラス・メソッドのリファレンスは書こう(・∀・)
  6. 6. Hoge Doc• Java Docに代表されるHoge Docって結構ある • Java Doc • PHP Documenter • Py Doc • RDoc
  7. 7. JSDoc ToolKit• Javascript用ドキュメントツール• JSDocの後継• @hoge foo barスタイルのJava Doc風
  8. 8. /** * @class /ALLIANCE/作成 * @author <a href="mailto:sano-n@klab.jp">Naohide Sano</a> (sano-n) * @extends KNGP.GLPage */var AllianceCreatePage = KNGP.GLPage.subclass(/** @lends AllianceCreatePage.prototype */{ /** * Sets current step on the page. * And control UI enabling. * @private * @param {Number} step */ _setStep: function(step) { //... }}
  9. 9. アノテーション• 動的言語ならではのアノテーション • @extends • @lends • @constructor • @class, @function, @field • @private
  10. 10. 独自アノテーションも追加したいな(´・ω・`)
  11. 11. プラグイン• Javascriptでプラグインも簡単に作れる• ドキュメント生成時の各ライフサイクルをフック
  12. 12. JSDOC.PluginManager.registerPlugin( "JSDOC.tagSynonyms", { onDocCommentSrc: function(comment) { comment.src = comment.src.replace(/@methodOfb/i, "@functionn@memberOf"); comment.src = comment.src.replace(/@fieldOfb/i, "@fieldn@memberOf"); }, onDocCommentTags: function(comment) { for (var i = 0, l = comment.tags.length; i < l; i++) { var title = comment.tags[i].title.toLowerCase(); var syn; if ((syn = JSDOC.tagSynonyms.synonyms["="+title])) { comment.tags[i].title = syn; } } } });
  13. 13. 注意点• シノニムが結構ある • @returns == @return • @constructor == @constructs • @augments == @extends • etc...
  14. 14. おわり

×