Examples

File header comment example

/*
 * Description: This file content calculates the area of a rectangle.
 * Author: Jin Jackson.
 * History:
 * - 2022-01-01: Created - dev22.
 * - 2022-01-05: Added support for calculating perimeter - dev22.
 */

Class comment example

/// <summary>
/// Created by: jin.jackson.</br>
/// Created date: 2023-03-20.</br>
/// Description: This class is used to configure the password settings and validate password.
/// </summary>

Method comment example

/// <summary>
/// Validates a given username and returns a boolean indicating whether it is valid or not.
/// </summary>
/// <param name="username">The username to validate.</param>
/// <param name="errorMessages">The error messages if the username is not valid.</param>
/// <returns>True if the username is valid, false otherwise.</returns>

Property comment example

/// <summary>
/// This is a property or variable.
/// </summary>