Daniel Pitts wrote:
>
> Or, using javadoc to bury the smell of bad naming conventions.
>
> Which would you rather see, the javadoc version?
> // Ask the scenes forensic-material-team to scout the scene.
> fmt().go(s)
> --- or the self-documenting version?
> getForensicMeterialTeam().scout(scene);
>
What will your javadoc for the getForensicMeterialTeam() method look like?
Perhaps,
/**
* Returns the forensic materials team relevant to the current
* investigation.
*
* @return team responsible for investigating materials at the
* behest of a judiciary
*/
The point being, it's lovely to have getForensicMeterialTeam() in your
code, instead of the alternative above, but you won't get rid of the
comment: you'll just move it (to a more appropriate place).
And the code will no-doubt continue:
CSITeam csiTeam = getCSITeam();
csiTeam.everyoneLookSeriousAndProfessionalAndUtter lyDedicatedToThePointOfBeingPaperThinCharacterisat ionsOfOneDimensionalCartoonCharacters();
..ed
--
www.EdmundKirwan.com - Home of The Fractal Class Composition.
Download Fractality, free Java code analyzer:
http://www.EdmundKirwan.com/servlet/...c-page130.html