タグ

2012年8月3日のブックマーク (1件)

  • ドックコメントの書き方 - JsDoc Toolkitを使う!

    的な書き方 JsDoc Toolkitのドックコメントの書き方はJavaDocの記法をベースにしています。基的な記述ルールは以下のとおりです。 ドックコメントは /** から始まり */ で終わるコメントブロックで、複数行に渡って書くことができます。ドックコメントはタグと説明文から構成されます。 一般的にドックコメントは、その直後に現れるソースコードを対象にする記述と解釈されます。(ただし、@nameタグなど例外もあります) タグは"@"から始まるキーワードで、ドックコメントの対象に対し様々な意味づけを行います。タグは説明文を伴うこともあります。 タグは行の先頭に書かれている必要があります。@linkタグを除き、行の途中に書かれたものはタグと解釈されませんので注意してください。 説明文はHTMLテキストで、HTMLタグを使用できます。複数行に渡って記述することができますが、改行は認識

    ドックコメントの書き方 - JsDoc Toolkitを使う!
    eriko315
    eriko315 2012/08/03
    コメントを自動的にドキュメントへ生成するツールキット。ツールキット自体は使わなくてもコメントの書き方が参考になる。