My personal preference when it comes to code documentation is place quick references or short descriptions as inline documentation and then in a separate document, write out the full documentation. It not only helps anyone who has to pick up your application
but it can also help if you forget what a section or code stub does.
Mark as answer posts that helped you.
Marked as answer by bbcompent1 on May 04, 2012 02:11 PM
bbcompent1
All-Star
32984 Points
8505 Posts
Moderator
Re: Documenting your WEB API. In code or in seperate documents?
May 03, 2012 02:51 PM|LINK
My personal preference when it comes to code documentation is place quick references or short descriptions as inline documentation and then in a separate document, write out the full documentation. It not only helps anyone who has to pick up your application but it can also help if you forget what a section or code stub does.