JSDocコメント - Google JavaScript スタイルガイド - 日本語訳
#divclass(page_title){ &this_page() } 我々は&blanklink(C++ style for comments){http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#Comments}の考え方に従います。 全てのファイル、クラス、メソッド、プロパティに&blanklink(JSDoc){http://code.google.com/p/jsdoc-toolkit/}コメントが、適切な&link_anchor(jsdoc_tag_reference){タグ}と&link_anchor(js_type_language,pageid=17){データ型}を伴って記されるべきです。また名前から明白に判断できる場合を除き、プロパティ、メソッド、メソッドの引数、メソッドの戻り値を説明する文章
JavaScriptコーダー必見！クールなJsDoc用テンプレート「JsDoc2-Template-Bootstrap」 | DOTAPON Blog
JavaScriptで大規模開発をされているみなさま、ドキュメントジェネレータは活用してますか？ ソースコードにコメントを入れておくと、自動でHTMLに仕上げてくれるアレのことです。 /** * 足し算した結果を取得します。 * * @param {Number} num1 * 足される数 * @param {Number} num2 * 足す数 * @return {Number} * 結果 */ function add(num1, num2) { return num1 + num2; } JavaScript向けのツールで有名なのが「JsDoc」。 そのまま使うと無難なデザインのHTMLが出来上がってしまいますが、テンプレート機能を使って自由に拡張できます。 そこで今日ご紹介するのが…！ JsDoc2-Template-Bootstrap いかがでしょう、Twitter Bo
今さらながら知ったWebStormとJSDocの深〜い関係 – 宇都宮ウエブ制作所
正宗です。ものすごく今さらな事を知ったのでおおはしゃぎで書き留めておきます。いかに今までまともにJSDocを書いていなかったか。 私が主に JavaScriptを書くときに使っているWebStormでJSDocをきちんと書くようにすると、JavaScriptの型をなかなか強力にサポートしてくれるようになりました。コードの補完機能なんかもかなり精度が上がってくるので、結果的にコーディングも速くなるのではないでしょうか。 私は特に普段はActionScript3を書く機会が多く、ご存じのとおりActionScript3は型を明示できる言語なのでFlashBuilderやFlashDevelop、FlashCS5などのIDEに備わっている補完機能に頼り切ってコーディングしていました。そのスタイルのままJavaScriptのほうの開発を行うと、今まではJavaScriptで厳密に型を明示できないこ
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
