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){データ型}を伴って記されるべきです。また名前から明白に判断できる場合を除き、プロパティ、メソッド、メソッドの引数、メソッドの戻り値を説明する文章
TypeScript の API ドキュメントを Markdown で出力するツールを作った - Qiita
TypeScript で API ドキュメントを Markdown で出力できるものを作りました。 https://www.npmjs.com/package/typedoc-markdown-theme 使い方 TypeDoc という、 TypeScript のコードから API ドキュメントを HTML で生成してくれるツールがあります。 http://typedoc.io/ こちらのパッケージ、 theme というのを設定することで、ドキュメントの見た目を変えることができます（未設定の場合はデフォルトの theme が使われる）。 本来は DOM 構造を変えたり CSS をいじったりするような用途が想定されているであろう機能ですが、大胆に Markdown にしてみました。 ということで、 使い方は以下のような感じです。 より詳細なオプションの指定方法等は TypeDoc のドキュメ
Comprehensive Guide on How to Get Rid of Text Background Color in Google Docs - Wallpapers.com Blog on Wallpapers
Google Docs, an integral part of Google's suite of productivity tools, has risen in popularity due to its easy-to-use interface and collaborative features. One such feature is the ability to add or remove background color in texts. While adding color can help emphasize specific sections of your document, there may be instances where you need to get rid of the text background color in Google Docs.
JsDoc3-manual-jp - アノテーションの書き方
JsDocはソースコードを解析します。 しかし、引数の意味やクラスの意味などはソースコードから読み取ることはできません。 そこで、ソースコードからだけでは得られない情報をアノテーション（注釈）という形で記述することで JsDoc に通知してやります。 /** * ほげほげなクラス。 * @constructor * @param {number} hoge 「ほげ」の出力回数。 */ function HogePrinter(hoge) { this.hoge = hoge; } /** * ほげほげを出力するメソッド。 * @param {number} [num] ほげほげ回数。省略可能。 * @return {string} ほげほげ文字列。 */ HogePrinter.prototype.print = function(num) { var hoges = []; for (v
JSDoc使い方メモ - Qiita
JSDoc で API ドキュメントを生成する方法と、一部のドキュメンテーションタグの使い方についてメモする。 環境 OS Windows7 64bit Java 1.7.0_51 JSDoc 3.2.2 インストール Java Mozilla Rhino を使った方法でドキュメントを生成するので、 Java が必要。 インストール方法は割愛。 JSDoc 3 GitHub からダウンロードできる。 tags から v3.2.2 を選択して、 zip でダウンロードする。 zip を解凍したら、解凍後のフォルダにパスを通し、コマンドラインからヘルプを表示できることを確認する。 >jsdoc --help OPTIONS: -t, --template <value> The path to the template to use. Default: path/to/jsdoc/templa
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
TypeDoc入門 - Qiita
Node.js+gulp+jsdocでAPIドキュメントを生成 - Qiita
gulp-typedoc
AngularJSプロジェクトにおけるngdoc・jsdocルール案 · Issue #65 · HAKASHUN/manabi