Comment file

 /// This is the head comment of a file.

 /*************************************************************************
 *\CopyRight:  2015.9.21-NOW,Feel free to use and modify those codes. And
 any modifications or copies shall remain these sentence for the purpose
 of further development and code sharing.
 *\Module/Sys: [M]/[S]Test
 *\Version:    1.0.0.0
 *\Description:Use for the describ of the functions of the file.
 *\Author:     CityForNaive
 *\Date:       2015.9.21
 *\History:    <Date>                <Dev>                <Behavior>
 *\            2015.9.21             CityForNaive         Build.
 *************************************************************************/

 #pragma once /// Use this as first option.

 #ifndef _COMMENT_H_
 #define _COMMENT_H_
 #endif // _COMMENT_H_

 /// Comments of the definations as follow.

 #define _TEST_SUCCEED            1 /** Test succeed. */
 #define _TEST_PARTIAL_SUCCEED    2 /** Test partial succeed. */
 #define _TEST_FAILED            0 /** Test failed. */

 /// This is the description of a class or a struct.

 /**
 *\Description:Use for the test functions.
 *\Methods:    1.SetTester : Set the basic param of the test
               2.GetTester : Get the result of a test.
 *\Other:      This is a C based class.
 */
 class TestClass
     : public TestBaseClass
 {
 public:
     TestClass( void );
     virtual ~TestClass( void );

 public:
     /**
     *\Description:Set function for the test class.
     *\Input:      1.const int& param1, the first param of the func.
                   2.const int& param2, the second param of the func.
     *\Output:     None.
     *\Return:     const int : _TEST_SUCCEED, succeed
                               _TEST_PARTIAL_SUCCEED, partial succeed
                               _TEST_FAILED, failed.
     *\Other:      None.
     */
     const int SetTester( const int& param1, const int& param2 );

     /**
     *\Description:Get the result of a test.
     *\Input:      1.const int& token1, the first token of the func.
                   2.const int& token2, the second token of the func.
     *\Output:     1.int& result, the result of the test.
     *\Return:     const int : _TEST_SUCCEED, succeed
                               _TEST_PARTIAL_SUCCEED, partial succeed
                               _TEST_FAILED, failed.
     *\Other:      None.
     */
     const int GetTester( const int& token1, const int& token2,
         int& result );

 private:
     int m_iParamFrst;    /// The first param of the test.
     int m_iParamScnd;    /// The second param of the test.
 }; // TestClass

 /// The comments in detailed code lines.

 /// I intended that the implementation of a method shall be in another file.

 /** Set function for the test class. */
 int TestClass::SetTester( const int& param1, const int& param2 )
 {
     int rtnVal; // The return value of this function
     rtnVal = _TEST_FAILED;

     // Set the param of the test
     if ( param1 >=  && param2 >=  )
     {
         rtnVal = _TEST_SUCCEED;
     }
     else if ( param1 >=  || param2 >=  )
     {
         rtnVal = _TEST_PARTIAL_SUCCEED;
     }
     else
     {
         rtnVal = _TEST_FAILED;
     }

     m_iParamFrst = param1;
     m_iParamScnd = param2;

     return rtnVal;
 }

 /** Get the result of a test. */
 int TestClass::GetTester( const int& token1, const int& token2, int& result )
 {
     int rtnVal; // The return value of this function
     rtnVal = _TEST_FAILED;

     // Judge the token to decide the result
     if ( token1 == m_iParamFrst && token2 == m_iParamScnd )
     {
         result = m_iParamFrst * m_iParamScnd;
         rtnVal = _TEST_SUCCEED;
     }
     else if ( token1 == m_iParamFrst || token2 == m_iParamScnd )
     {
         result = m_iParamFrst / m_iParamScnd;
         rtnVal = _TEST_PARTIAL_SUCCEED;
     }
     else
     {
         result = ;
         rtnVal = _TEST_FAILED;
     }

     return rtnVal;
 }

 /// For interface that we just write the brief of the function.

 class __declspec( novtable ) ITestInterface
 {
 public:
     /** This is a function of the interface. */
     virtual void func( const int& param, const char* charParam ) = ;
 };

 /// here we can also use EXTERN_C instead of extern "C" if under VS.
 extern "C" __declspec( dllexport ) ITestInterface* getTestInterface();

以上是换了一家公司之后,根据公司内部的 code rule 自己整理的自己以后进行编码的参考格式(当然,现在这家并不是做什么开源项目的:3>)