A better method for coding comments

In the. h file, the first line of each function is described.

Public:
// Construct an octotree with pgeo
Void buildoctree (cgeometry * pgeo );

 

In the. cpp file, the following content is described before the function: functions, return values, and passing parameters.

/*---------------------------------------------------------------------------
Function: Construct an adaptive octotree for the ry.
Return Value: None
Passing parameter: pgeo needs to construct the ry Object Pointer of the octotree.
-----------------------------------------------------------------------------*/
Void coctree: buildoctree (cgeometry * pgeo)

{

.............

}

 

It feels great.