メソッド宣言のすぐ上に置くドキュメントの正しい用語は何ですか？

Question

私はホワイトペーパーを書いており、定義の宣言の前にコメントブロックとして入れた内部文書の公用語が何であるか分かりません。

最終的にJavaDocメンバーのドキュメントになる同じこと。

これは単に内部文書ではなく、「ヘッダー文書」が良い用語であるかどうかはわかりません。それは、多くの場合、専門的に「必要条件節」、または「保険の句と呼ばれます

Answer 1

これは、メソッド指定またはという手順仕様と呼ばれます。つまり、実装の詳細ではなく、プロシージャの動作を指定します。いくつかのテキストブックは、メソッドの契約としてそれを参照していますが、それは少しあいまいかもしれません。

Answer 2

（例えば、Javaの/ Perlの）特定の言語に固有のものではない1私は、一般的な用語を探しています

注意、 "

Answer 3

私の組織では、それをメソッドまたは関数doc-commentと呼びます。関数レベルのドキュメントは、おそらくより広く使われている用語です。

Answer 4

私は、それをクラスまたはファイルコメントと区別するために、常にメソッド（または関数）コメントと呼びます。

Answer 5

私はコードコメントと呼んでいます。

Answer 6

通常、「インラインドキュメント」と呼ばれます。私にとっては、ドキュメントはのソースコードであるため、ドキュメントがコードと同期している可能性はますます高まっています。

（これはもちろん、保証するものではありませんが、それは彼らの野菜を食べるようにプログラマを奨励ん。それは、開発者が同じ場所で同じ時間とで動作の変更をドキュメントを変更することができることを意味し、のではなく、事実の後、別の場所で）