文書内の複数のインスタンスを参照するための規約

Question

この質問の回答を見つけることができませんでした。プログラミングに関する質問以外にも、ドキュメンテーションのための英語の質問です。 checkBar（...）のための私のドキュメントで

class Foo { 
    public void checkBar(Collection<Bar> bars) { 
     ... 
    } 
} 

、この方法は、例えば、複数のバーインスタンスを扱うことを指摘するための一般的な慣習があります。

/** 
* checkBar(...) checks a set of (Bar instances) or (Bar/s) or 
* (Bar objects) or (a Bar set) 
*/ 

Answer 1

私は、「チェック{@link}バーのコレクション」ユーザーがバーのJavaDocにジャンプするバーをクリックすることができるようにJavaDocでのリンクを使用して行くだろう。

インターフェイスがCollection<Bar>ではないので、私は "a bar set"から離れています。これは混乱する可能性があります。Set<Bar>