25 July 2013

Commenting As Part of Self Documentation

Unit Testers, especially those who are involved in TDD, have a good hobby of self documentation. Sometimes, the unit test itself is a proof of this.

For my team, I advise you to never forget to add the summary, parameters (optional), and the expected output or returns on top of every method.

Sample:

///<summary>
///Checks the database to view user accounts.
///</summary>
///<param name="userID"> The ID of the current user </param>
///<returns> The list of accounts </returns>

No comments:

Post a Comment