Comments in the File Header

Problem
You’re interested in adding file header documentation to your source files.

Solution
Consider placing a standard block of code comments at the top of all source files.

Comments
These comments can include the programmer’s name, creation date, and so on. Use the #region directive so comments can be easily collapsed and kept out of sight.

Example

#region Copyright Avid Tester 2018
/*
 * Description: Answer to the ultimate question of life.
 * Author: Jason Riley
 * Date: May 3, 2018
 *
*/
#endregion

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google+ photo

You are commenting using your Google+ account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

w

Connecting to %s