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

Question

私はホワイトペーパーを書いていますが、定義の宣言の前にコメントブロックとして配置する内部ドキュメントの種類の正式な用語が何であるかわからないことに気付きました。

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

これは単なる内部ドキュメントではなく、「ヘッダードキュメント」が適切な用語であるかどうかはわかりません。

特定の言語（Java / Perlなど）に固有の用語ではなく、一般的な用語を探していることに注意してください。

score 4 · Accepted Answer

これは、メソッド仕様またはプロシージャ仕様と呼ばれます。つまり、実装の詳細ではなく、プロシージャの動作を指定します。いくつかの教科書はそれを方法の契約と呼んでいますが、それは少し曖昧かもしれません。

score 3 · Accepted Answer

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

score 3 · Accepted Answer

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

score 0 · Accepted Answer

これは、専門的に「要件条項」または「保険条項」と呼ばれることがよくあります。

score 0 · Accepted Answer

私は通常それを「インラインドキュメント」と呼んでいます。私にとっては、それが何であるかということです。ドキュメントがソースコードに含まれているため、ドキュメントがコードと同期し続ける可能性が高くなります。

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

score 0 · Accepted Answer

0

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

于 2008-10-02T00:09:47.940 に答える

6 に答える 6