My favorites | Sign in
Project Home Wiki Issues Source
READ-ONLY: This project has been archived. For more information see this post.
Search
for
  Advanced search   Search tips   Subscriptions
Issue 6: Documentation
1 person starred this issue and may be notified of changes. Back to list
Status:  Done
Owner:  meff.jey...@gmail.com
Closed:  Sep 2011


 
Project Member Reported by meff.jey...@gmail.com, Sep 2, 2011
Documentation
C++: Use Doxygen to document the interfaces.
Java: Use javadoc to document the interfaces.
Python: Use pydoc to document the interfaces.
The above documentation only needs to be generated from Collatz.[h | java | py].
Comment each function meaningfully.
Use comments only if you need to explain the why of a particular implementation.
Choose a coding convention and be consistent.
Use good variable names.
Write readable code with good indentation, blank lines, and blank spaces.
Sep 6, 2011
Project Member #1 meff.jey...@gmail.com
I have not started this at all.
Status: New
Sep 7, 2011
Project Member #2 meff.jey...@gmail.com
Finished
Status: Done

Powered by Google Project Hosting