This Page documents all Stand Clarity Processes for Commenting C# or
VB.NET code
In Visual Studio, by typing /// at the top of function or event an XML
comment is generated.
These comments can be consumed and made into CHM files for code
transference and provided as development documentation at the end of the
project.
Here is an Example Snippet of code:
/// <summary>GetFacilityById returns a Facility object By its'
Id</summary>
/// <param
name="context">EHSExperts.Data.EHSExpertsDataContext</param>
/// <param name="facilityId">int FacilityId</param>
/// <returns>EHSExperts.Data.Facility</returns>
public static EHSExperts.Data.Facility
GetFacilityById(EHSExperts.Data.EHSExpertsDataContext context, int
facilityId)
{
...
}
If in any function or workflow throughout the code you needed to perform
highly technical or complex logic to get the desired behavior please
take a moment and try to explain this code to anyone else who may be
looking at it. A good rule of thumb is if a complex data manipulation
needs is performed or the code in the function took over 30 minutes to
get in working order, document the functionality so you or another
developer can quickly understand why something was written the way that
it was.