Home
Comments - Do you have brand at the top of each file?
  v2.0 Posted at 24/04/2018 9:42 AM by Tiago Araujo

The brand is the summary of our company, the product and release information, and can be used by other developers to quickly know the release history and product summary.

The brand should contain at least the following:

  • Copyright declaration
  • Purpose of the document/file
  • Author name​​

If the file was modified by another developer, the comment should also contain:

  • Reviewer name

​Header comments

On top of the file:

///<summary>
///'----------------------------------------------
/// Copyright 2017 Superior Software for Windows 
/// www.ssw.com.au All Rights Reserved.
///'----------------------------------------------
/// Comment: User class to handle user preference and login information
/// Authors:   DDK,PH
/// Reviewers: AC,RD
///</summary>
///'---------------------------------------------- 


Related rules

    Do you feel this rule needs an update?

    If you want to be notified when this rule is updated, please enter your email address:

    Comments:

    Note: Social Media login for Yotpo is not working in IE or Safari, please use Chrome. We are waiting for Yotpo to fix it.