問題タブ [code-documentation]

JavaDocs のような方法で自分のコードを文書化する方法を検討しています。

何か案は？

UFT 11.52 を使用しています

これまでのところ、NaturalDocs + Perl を見てきました。

他のアイデアはありますか？

前もって感謝します。

私はEclipseでPyDevを使ってPythonを開発しています。コードにドキュメントを適用するのに役立つプラグインを探しています。

そのようなプラグインを知っている人はいますか？

ありがとう

Java API ドキュメントと Java コードの説明と確認をどこで求めればよいか分からないので、ここで行います。

の API ドキュメントでFileChannel、オフ バイ ワン エラー wrt to filepositionおよびsize複数の場所でのファイルを見つけました。

これはほんの一例です。州の API ドキュメントtransferFrom(...):

「指定された位置がファイルの現在のサイズより大きい場合、バイトは転送されません。」

OpenJDKコードにもこのコードが含まれていることを確認しました...

FileChannelImpl.java...ドキュメントと一致するファイル内。

さて、上記のコード スニペットと API ドキュメントは相互に一貫しているように見えますが、ファイルのデータへの 0 ベースのインデックスであるため、上記は単なる「より大きい」ではなく「以上」であるべきだと「感じます」 。での読み取りには、呼び出し元に返すデータがありません! ( では、少なくとも 1 バイト (ファイルの最後のバイト) が呼び出し元に返される可能性があります。)positionposition == size()position == size() - 1

同じ API ドキュメント ページにある他の同様のインスタンスを次に示します。

1. position(...): "位置をファイルの現在のサイズより大きい値に設定することは正当ですが、ファイルのサイズは変更されません。" (「以上」である必要があります。)

2. transferTo(...): "指定された位置がファイルの現在のサイズより大きい場合、バイトは転送されません。" (「以上」である必要があります。)

3. read(...): "指定された位置がファイルの現在のサイズより大きい場合、バイトは読み取られません。" (「以上」である必要があります。)

最後に、 の戻り値に関するドキュメント セクションはread(...)、残りのドキュメントとの一貫性さえ保っていません。ここにそれが述べているものがあります：

read(...)

戻り値：

読み取られたバイト数。場合によってはゼロ、または指定された位置がファイルの現在のサイズ以上の場合は -1

したがって、この唯一の例では、彼らが正しいことを述べているのを見ます。

全体として、私はこれらすべてをどうすればよいかわかりません。今日、このドキュメントに一致するコードを書いた場合、Java (コードまたはドキュメント) の将来のバグ修正によってコードがバグだらけになり、私の側でも修正が必要になります。今日の状態で正しいことを自分で行うと、最初からコードにバグが発生します。

別の次元内にある配列の値/オブジェクトを文書化する正しい方法はありますか?

通常、配列は次のように処理されます。

しかし、私はこのようなものが必要です:

これは明らかに機能していません。正しい PHPDoc 表記法は何ですか?

そのため、私の目的の c プロジェクト用に doxygen で生成されたドキュメンテーション ドキュメンテーションのドキュメンテーション ガイド ページを作成しようとしていますが、うまくいかないようです。

問題は、@interface により、doxygen が object-c のマークダウン構文の強調表示を出力するだけでなく、ページのインターフェイスを作成しようとすることです。これを回避する方法はありますか？

お時間をいただきありがとうございます。

問題:
SCParserDelegate プロトコルの例では、メソッドごとにドキュメント コメントが書かれているはずです。

コンテキスト:
サード パーティの開発者が使用する解析フレームワークを構築しています。(これは私の最初のフレームワーク プロジェクトであるため、私の開発プロセスは学習を最大化するための高度なアカデミックです。)

サンプルコード:

質問:
上記のサンプル コード内のメソッドとプロパティごとに独自のドキュメント コメント ブロックを手動で記述するにはどうすればよいですか?