Skip to content

mzer0-yu/CommentSample

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 

Repository files navigation

#C/C++

  • Must enable C++ style comment
  • will support for Doxygen in the furture

Titles

Title 1

// Your Text Here
// Your Text Here
// Your Text Here

Title 2

//
  // Your Text Here
  // Your Text Here
  // Your Text Here
//

Title 3

//
  //
    // Your Text Here
    // Your Text Here
    // Your Text Here
//

Title 4

//
  //
    //
      // Text Here
      // Text Here
      // Text Here
//

Block

/*---------------------------------------
              Your Text Here
---------------------------------------*/

/*--------------End Block--------------*/

Warnings

//! WARNINGS
//! Your Text Here
//! Your Text Here
//! Your Text Here

Explanation

//* EXPLAIN
//* Your Text Here
//* Your Text Here
//* Your Text Here

Reference

//@ [number/letter] http(s)://......

//* That's an example
//* see [1] for more information.
//* see [2] to know about the author.
//@ [1] https://github.com/mzer0-yu/CommentSample
//@ [2] https://github.com/mzer0-yu

License

/* LICENSE
    Your Text Here
    Your Text Here
    Your Text Here
LICENSE */

Declaration

/*
  result name(par1, par2, ...)
  
  Decl(Declared) in ???.h ???.h ...
  Invl(Involved) in ???.cpp ???.cpp ...
  Writen by ??? ??? , Month Day/Year
  See [?] for more info
  ----------------------------
  @ result: Your Text Here
  @ par1: Your Text Here
  @ par2: Your Text Here
  
  ! WARNINGS
  ! Your Text Here
  ! Your Text Here
  
  * EXPLAIN
  * Your Text Here
  * Your Text Here
  * Your Text Here
*/

Definition

/*
  result name(par1, par2, ...)
  ----------------------------
  Decl(Declared) in ???.h
  Dpnd(Depend) on ???.h
*/

About

The comment rules of C++ language

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published