10

Python、MATLAB、E-Lisp などの言語には、doc-string 用のこの優れた機能があります。この機能を使用すると、ターミナルで数回のキーストロークを使用するだけで、作成してコードにインポートした関数/モジュールのドキュメントを取得できます。

C ++ / Cで同様の機能を取得するための「テクニック」(ライブラリ、エディターのトリック、何でも)があります。ソースファイル内の関数のドキュメントを関数の先頭に含めるとします。ターミナルで getinfo のようなコマンドを入力します。(マニュアルページのようなもの)

このような「man」機能が多くの C 関数に存在することは知っていますが、これらの関数のドキュメントはソース コードとは別のテキスト ファイルに記述されています。書類をそろえたい

4

3 に答える 3

6

doxygenのようなものを使用できます。man ページの生成などのフォーマットがサポートされています。

于 2012-05-28T15:31:25.033 に答える
0

Javadocと同様の構文でコードにコメントを付けると、Doxygenを使用して、さまざまな形式でコードのドキュメントを生成できます。とりわけmanページを生成できますが、人々が使用する好ましい出力形式はHTMLページのようです。

于 2012-05-28T15:29:06.843 に答える