Skip to content

Latest commit

 

History

History
46 lines (35 loc) · 1.27 KB

1. Comments and Documentation.md

File metadata and controls

46 lines (35 loc) · 1.27 KB

12 Comments

12.0 Introduction

Comments can only be used to explain what code can't. Whether the code is visible or not.

12.1 Copyrights

Comments highlighting copyrights should follow this pattern:

Do
    // ---------------------------------------------------------------
    // Copyright (c) Coalition of the Good-Hearted Engineers
    // FREE TO USE TO CONNECT THE WORLD
    // ---------------------------------------------------------------
Don't
    //----------------------------------------------------------------
    // <copyright file="StudentService.cs" company="OpenSource">
    //      Copyright (C) Coalition of the Good-Hearted Engineers
    // </copyright>
    //----------------------------------------------------------------
Also, Don't
   /* 
    * ==============================================================
    * Copyright (c) Coalition of the Good-Hearted Engineers
    * FREE TO USE TO CONNECT THE WORLD
    * ==============================================================
    */

12.2 Methods

Methods that have code that is not accessible at dev-time, or perform a complex function should contain the following details in their documentation.

  • Purposing
  • Incomes
  • Outcomes
  • Side Effects