Konvention für den Verweis auf mehrere Instanzen in der Dokumentation

Question

Ich konnte keine Antwort für diese Frage finden - es ist eine Frage in englischer Sprache für die Dokumentation mehr als eine Programmierfrage.

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

In meiner Dokumentation für checkBar (...), ist es eine gemeinsame Konvention zur Feststellung, dass die Methode beschäftigt sich mit mehreren Bar Fällen, zB.

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

Answer 1

ich mit „überprüft eine Sammlung von {@link Bar} s“, die die JavaDoc des Links verwenden gehen würde, so dass Benutzer auf der Bar klicken können, um die Bar javadoc zu springen.

Ich würde von "einem Bar-Set" bleiben, da die Schnittstelle Collection<Bar> nicht Set<Bar> ist, die verwirrend sein kann.