16

私は CoffeeScript が初めてで、Javadoc 構文を使用する CoffeeScript のドキュメント ジェネレーターが見つからないようです。私が見つけた唯一のものは、CoffeeScript コンパイラへのパッチとして入手できます。

では、CoffeeScript の Javadoc コメントからドキュメントを生成するには、何を使用しますか? または、関数の引数と戻り値をどのようにドキュメント化しますか?

4

4 に答える 4

22

そのため、JavaDoc構文がJavaScript開発者に実際に浸透したことはありません。そのようなもの、特にGoogleを使用している人もいますが、静的型付けがなく、任意の関数に対して任意の数の引数を許可するJSとは少し対立しています。

CoffeeScriptを使用して美しいドキュメントを作成する場合、標準はDoccoです（そのホームページは優れた例です）。すべての関数に対してJavaDocスタイルのコメントを作成する場合は、手動で作成し、バッククォートでエスケープする必要があります。

または、コードがリリース可能になるまでCoffeeScriptで作業し、結果のJavaScriptを文書化することもできます。

于 2011-05-01T19:50:31.207 に答える
15

Docco は、prozedural コーディング スタイルに最適です。API を文書化したい場合は、coffeedocが最適です。

于 2011-12-01T14:34:21.763 に答える
7

coffeescript で javadoc スタイルのドキュメントを使用することを楽しみにしている人は、codo ( http://netzpirat.github.com/codo/ ) をチェックアウトできます。これは、javadoc のサブセットのサポートを提供し、ソース コードからクラス名、関数名、およびパラメーターを自動的に推測します。

于 2012-07-29T04:36:05.407 に答える
0

YUIDocを使用しています。Javadoc に似た構文を使用して、クラス、メソッド、およびイベントにコメントを追加できます。ドキュメントは html/css ファイルとして出力され、ページ レイアウトをカスタマイズすることもできます。

このドキュメントの例を確認してください: http://yui.github.com/yuidoc/api/

PS: Node.JS に依存しており、パッケージ yuidocjs をインストールする必要があります

npm install yuidocjs -g
于 2012-11-26T06:19:39.343 に答える