编码规范

Qter

PC-Lint 是GIMPEL SOFTWARE 公司研发的C/C++软件代码静态分析工具，他的全称是 　　PC-Lint/FlexeLint for C/C++。PC-Lint 能够在Windows、MS-DOS 和OS/2 平台上使用，以二 　　进制可执行文档的形式发布，而FlexeLint 运行于其他平台，以源代码的形式发布。PC-lint 　　在全球拥有广泛的客户群，许多大型的软件研发组织都把PC-Lint 检查作为代码走查的第一 　　道工序。PC-Lint 不但能够对程式进行全局分析，识别没有被适当检验的数组下标，报告未被 　　初始化的变量，警告使用空指针连同冗余的代码，还能够有效地提出许多程序在空间利用、 　　运行效率上的改进点。

代码码块折叠
#pragma  region  基本操作
        ......
#pragma  endregion



代码注释
动态生成文档
doxygen
Graphviz
Doxgen--文件模板
--------------方法1--------<>内的中文字符要加空格如： < 修改内容 >-----------------------------------
/** \file Preferences.cpp
********************************************************************************
<RE>
模块名 : < wyyt >
文件名 : <references.cpp>
相关文件 : < Preferences.h >
文件实现功能 : 参数配置
* 1-
* 2-
作者 : <IHAS>
版本 : <1.0>
版权 : Copyright (c) 2012 IHAS
创建日期 : <2012/07/29>
--------------------------------------------------------------------------------
备注 : < 其它说明 >
--------------------------------------------------------------------------------
修改记录 :
日 期         版本           修改人           修改内容
YYYY/MM/DD    X.Y        <IHAS>     < 修改内容 >
</PRE>
*******************************************************************************/



--------------方法2-------------------------------------------
/*! @file info
********************************************************************************
<RE>
模块名 : <面板实现头文件>
文件名 : <anelCtrl.h>
相关文件 : <与此文件相关的其它文件>
文件实现功能 :主要用来显示面板
* 1-
* 2-
作者 : <IHAS>
版本 : <1.0>
版权 : Copyright (c) 2010 IHAS
创建日期 : <2011/08/24>
--------------------------------------------------------------------------------
备注 : <其它说明>
--------------------------------------------------------------------------------
修改记录 :
日 期         版本           修改人           修改内容
YYYY/MM/DD    X.Y        <IHAS>     <修改内容>
</PRE>
*******************************************************************************/



注释模板--文件模板
/*! @file info
********************************************************************************
<RE>
模块名 : <面板实现头文件>
文件名 : <anelCtrl.h>
相关文件 : <与此文件相关的其它文件>
文件实现功能 :主要用来显示面板
* 1-
* 2-
作者 : <IHAS>
版本 : <1.0>
版权 : Copyright (c) 2010 IHAS
创建日期 : <2011/08/24>
--------------------------------------------------------------------------------
备注 : <其它说明>
--------------------------------------------------------------------------------
修改记录 :
日 期         版本           修改人           修改内容
YYYY/MM/DD    X.Y        <IHAS>     <修改内容>
</PRE>
*******************************************************************************/


注释模板--函数模板
        ----------------------------------方法1--写在函数前---------------------------
        /**
        *  设置ini文件内容
        *@param wstrModule
        *   [in] section名称，如[com]
        *@param wstrItem
        *   [in] key名称，如dir=
        *@param wstrValue
        *   [in] 设置内容，如C:\Down
        *@param wstrFile
        *   [in] 文件名，默认值为RunInfo.ini
        *@return bool
        *   成功返回true，失败返回false
        */

----------------------------------方法2--------写在函数前---------------------
        /*!
        Copies bytes from a source memory area to a destination memory area,
        where both areas may not overlap.
        @param [out] dest
        The memory area to copy to.
        @param [in] src
        The memory area to copy from.
        @param [in] n
        The number of bytes to copy
        @return void
        */

----------------------------------方法3--------写在函数前---------------------
        //! InitWinVersion static member function.
        /*!
        \sa 参见
        \param void.
        \return WORD 如果==0 系统版本太低 must be running on Windows 2000 or higer
        */

----------------------------------方法4--------写在函数后---------------------
        const char member(char c,int n) throw(std:ut_of_range) {}
        /*! \fn const char member(char c,int n)
         *  \brief A member function.
         *  \param c a character.
         *  \param n an integer.
         *  \exception std:ut_of_range parameter is out of range.
         *  \return a character pointer.
         */


注释模板--快速插入方法
Visual Assist X Options 对话框
  Advanced
        Suggestions
                Edit VA Snippets([snipit]小片、片段、不知天高地厚的年轻人)
注释模板--文件模板

/*! @file info
********************************************************************************
<RE>
模块名 : <面板实现头文件>
文件名 : <anelCtrl.h>
相关文件 : <与此文件相关的其它文件>
文件实现功能 :主要用来显示面板
* 1-
* 2-
作者 : <IHAS>
版本 : <1.0>
版权 : Copyright (c) 2010 IHAS
创建日期 : <2011/08/24>
--------------------------------------------------------------------------------
备注 : <其它说明>
--------------------------------------------------------------------------------
修改记录 :
日 期         版本           修改人           修改内容
YYYY/MM/DD    X.Y        <IHAS>     <修改内容>
</PRE>
*******************************************************************************/