Communicate with Comments

/// Comments

After declaring the public method or field,  enter “///” in the line above it, that will auto fill a comment block. This will also enable hover help text.

Summary Comment Example:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
/// <summary>
/// Initializes a new instance of the <see cref="EnemyLoader"/> class.
/// </summary>
/// <param name='enemyName'>
/// Enemy name. e.g evilfrog bustyfox
/// </param>
/// <param name='successCallback'>
/// Success callback.
/// </param>
/// <param name='failureCallback'>
/// Failure callback.
/// </param>
public EnemyLoader( string enemyName, LoadSuccess successCallback, LoadFailure failureCallback)

Code Comment Example:

Bad Good
// increment enemies // we know there is now another enemy
enemies++; enemies++;

Leave a Reply

Your email address will not be published. Required fields are marked *