Sinnvolles kommentieren

[woodfighter]

Tach,

• @param <T> Type of data the buffer stores.

Erklärt sich das durch die Verwendung von Generics nicht schon selbst? Und ist @param nicht eh nur für Methoden definiert?

public interface Buffer<T> {

Ein Buffer-Interface? Tun's die vorhandenen Buffer nicht?

/**

• Resets the buffer.
• The buffer must not contain any data and have a size of 0 (zero) after this call. */

Wenn du das hier umformulierst, kannst du es dir sparen in den implementierten Klassen den Kommentar wieder zu überschreiben; für den Nutzer der Klasse ist es relevant, dass der Buffer hinterher leer ist (nicht sein sollte), der Implementierende kann aus dem selben Kommentar aber die für ihn nötige Information rausziehen: „After this call the buffer does not contain any data and has a size of 0 (zero)“.

• Copies the head of the buffer into an destination array so it is filled.

into a destination

mfg
Woodfighter