I am currently working alone on a web apps for a big client.
The client wants > 25% of comments in each of its software projects.
I checked the code of prev. apps. and here are my obs.
- each file begin with a comment block (package, date last updated, name of my company & copyright)
- all variables are commented with their names
// nameOfCustomer public String nameOfCustomer - all gets'n'sets are commented
- v few useful comments
It seems like devs just place as much comments as they can to hit that 25% threshold, regardless of quality and usefulness. My company tells me that "we do it as the client wants it".
I did not speak directly with the client about this. Here are my arguments so far :
- useless lines to read and to write (waste of time)
- comments are sometimes not updated (source of confusion)
- developers are less likely to use or trust real useful comments
What is your adv. on this sub? How should I handle the sit?