Menu

#4 insufficient technical docs

open
None
5
2002-05-21
2002-05-21
No

1. Update the structure document to explain why and
how various patterns are used.

2. Add javadocs to all classes. This isn't a request for
over the top commenting. Code should be self
describing. Comments should add value and tell the
reader something they probably didn't know about the
code e.g. why this algorithm was chosen.

The reason for 'bug' is that I'm meant to be a developer
on this project but I have little idea how the code works
any more!

Discussion


Log in to post a comment.

Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.