JavaDocs を扱うときにいつ使用すればよいですか@see? 使用方法は何ですか?
たとえば、MethodAが を呼び出す場合、の javadoc と参照を、それが呼び出し元であるため記述MethodBする必要がありますか、それとも が呼び出し元であるためからの参照を記述する必要がありますか。 Oracle の Web サイトで に関する内容を読みましたが、非常に曖昧に思えます。「参照」という意味だと書かれていますが、実際には意味が違います。@seeMethodBMethodAMethodBMethodA@see
ベストアンサー1
はい、かなり曖昧です。
メソッドのドキュメントを読む読者が他のメソッドも参照すると役立つ可能性がある場合は、必ずリンクを使用してください。メソッド A のドキュメントに「メソッド B と同様に動作しますが...」と記載されている場合は、必ずリンクを貼ってください。
代わりに@seeインライン{@link ...}タグを使用することもできます。
/**
* ...
* Works like {@link #methodB}, but ...
*/
methodA が methodB を呼び出すという事実が実装の詳細であり、外部からの実際の関係がない場合、ここでリンクは必要ありません。