Reply to post: Re: Mindset

Cloudflare goes retro with COBOL delivery service. Older coders: Who's laughing now? Turns out we're still vital

Martin Gregorie

Re: Mindset

I've had Java code for which the documentation is missing

There's absolutely no excuse for this given that the javadoc tool is part of the standard development package.

If the project is using waterfall development, the people writing module specs really should be formatting them as a Java skeleton (class-level comment and header followed by method-level comments and empty methods - this way the documentation is part of the source from the off.

For other development methods, code reviews should automatically be failed if class and method level comments are missing or cause javadoc to report errors and/or warnings.

I think any programming language, apart from assemblers or COBOL that doesn't have an equivalent tool is severely deficient - they're not hard to write: I wrote one for C that generates documentation after the style of 'The C Programming language' by K&R and use it for documenting private library functions.

POST COMMENT House rules

Not a member of The Register? Create a new account here.

  • Enter your comment

  • Add an icon

Anonymous cowards cannot choose their icon