Convenzione per il riferimento a istanze multiple nella documentazione

Question

Non sono riuscito a trovare una risposta per questa domanda- è una domanda in lingua inglese per la documentazione più di una domanda di programmazione.

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

Nella mia documentazione per checkBar (...), c'è una convenzione comune per notare che le offerte metodo con più istanze Bar, ad esempio.

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

Answer 1

vorrei andare con "controlla una raccolta di {@link Bar} s" che utilizzano il link del JavaDoc modo che gli utenti possono fare clic sulla barra per passare alla javadoc Bar.

Vorrei stare lontano da "un set Bar" poiché l'interfaccia è Collection<Bar> non Set<Bar> che può essere fonte di confusione.