FC2ブログ

スポンサーサイト

上記の広告は1ヶ月以上更新のないブログに表示されています。
新しい記事を書く事で広告が消せます。

JsDoc Toolkitを使ってみる

久しぶりにプログラミングをした。ほぼ2ヶ月ぶり。

JavaScriptで何か作ろうと思い、久しぶりなので Google JavaScript Style Guide を見直した。
今まで自分が書いたコメントは、このスタイルガイドに従っていないことに気づいた。
スタイルガイドには「JSDocのコメントを使用してください」とある。
自分のブログ記事を読み直したら、「JsDoc向けの記述は後回し」と書いていた。

せっかくなので、この機会にJsDoc用のコメントを書くことにした。
JsDoc Toolkitを使う! を参考にして、JsDoc Toolkitをダウンロード&インストール。
Google JavaScript Style Guide のコメント規約JsDocタグリファレンス を読んで、それらしいコメントを書くことができた。
少しコーディングして、JsDoc Toolkitでドキュメントを作成したら、意図したものが出力された。
今までに比べるとコメント量が増えた気がするが、とりあえずJsDoc用のコメントを書くようにしよう。

コメントを書いて気になったのは、プライベートなメンバの扱い。
JsDoc Toolkitでは、名前が アンダースコア _ から始まるメンバは、privateなスコープのメンバとして処理される。
Google JavaScript Style Guideの命名規約には、「Private のプロパティ, 変数, メソッドには, 末尾にアンダースコア _ を付けてください」とある。
Googleの方に従って、末尾にアンダースコアをつけてコメントに @private をつけるようにしたが、何で末尾なのかわからない。
先頭アンダースコアにして、意図せずにJsDoc出力対象外になることを防ぐためだろうか。

そんなわけで、今日はコメント書いただけで終わった。
スポンサーサイト

コメント

コメントの投稿

非公開コメント

プロフィール

himax64

Author: 南西
30代後半の無職です。
就活もせずダラダラ生きてます。
作ったもの

最新記事
人気記事
検索フォーム
カテゴリ
月別アーカイブ
最新コメント
最新トラックバック
RSSリンクの表示
QRコード
QRコード
カウンター
上記広告は1ヶ月以上更新のないブログに表示されています。新しい記事を書くことで広告を消せます。