Konwencja odnosząca się do wielu wystąpień w dokumentacji

Question

Nie byłem w stanie znaleźć odpowiedzi na to pytanie - jest to pytanie w języku angielskim dotyczące dokumentacji bardziej niż pytanie dotyczące programowania.

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

W mojej dokumentacji checkBar (...), czy istnieje wspólna Konwencja zauważyć, że metoda oferty z wielu wystąpień Bar, np.

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

Answer 1

pójdę z „sprawdza zbiór {@link Bar} s”, które wykorzystują Javadoc za odnośnik, dzięki czemu użytkownicy mogą kliknąć na pasku, aby przejść do javadoc Bar.

Będę trzymał się z daleka od "zestawu słupków", ponieważ interfejs jest Collection<Bar>, a nie Set<Bar>, co może być mylące.