According to Java’s commenting conventions, classes comments should describe a “thing”, rather than “actions”. It is easy when the class IS a thing (ex. a Clown), but what if it isn’t?

In this case, the ShapeProvider is a proxy class that requests “stringified” Strings to a small server application via the get method. The string is then parsed to build a BaseShape object, that is returned to the client of the service. The client simply draws the shape on a small GUI. This is a school work, so I’d want my comments to be as close as possible to the Java conventions.

/**
* 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
    }
}