Secondo le convenzioni di commento di Java, i commenti delle classi dovrebbero descrivere una "cosa", piuttosto che "azioni". È facile quando la classe È una cosa (ad esempio un Clown), ma cosa succede se non lo è?
In questo caso, ShapeProvider è una classe proxy che richiede "stringa" Strings a un'applicazione server piccola tramite il metodo get . La stringa viene quindi analizzata per creare un oggetto BaseShape , che viene restituito al client del servizio. Il client disegna semplicemente la forma su una piccola GUI. Questo è un lavoro scolastico, quindi vorrei che i miei commenti fossero il più vicino possibile alle convenzioni Java.
/**
* How should I comment this?
*/
public class ShapeProvider extends ServerConnection{
/**
* Method comment that is okay.
*/
public BaseShape get(){
//Requests the shape
//Parses the response
//Use a Factory to create an instance of BaseShape
//Return it
}
}