代码注释规范_

代码编写规范（草案）
(一) C++与 C#代码编写规范 每行代码字符数不超过 80 个字符。这个可以通过设置 visual assist x 显示提示标志。 设置方法 option---advance---display---display indicator after columns。对于超过 88 个 字符的在到达 88 个字符限制之前回车换行。 运算符号前后加空格，逗号后面加空格。如 for( int i = 0; i < width; i++ )或者函数中 的参数 void exchange( int firstNum, int secondNum )或者给变量赋值 int i = 0; if for while switch 等条件语句或者循环语句必须用花括号包起来。如下面示例： if( !isLoaded ) 改成用{}包起来====> if( !isLoaded )
using System;
namespace InitialFileProc
{ /// <summary> /// 处理.ini文件的读入和写出 /// </summary> class IniFile { /// 文件INI名称 public string Path;
/// 声明读写INI文件的API函数 [DllImport("kernel32")] private static extern long WritePrivateProfileString(string section, string key, string val, string filePath);
* Modified: $DATE$ $HOUR$:$MINUTE$
* * $end$ * * Copyright (C) Infrared Tech. Inst., XiDian Univ. * All rights reserved. * ** * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ 然后保存---确定。在编写代码时输入 fi 即可自动提示出 FileHeaderInformation 回车 后可以选择输入作者和修改者名字。这样一个文件头不仅可以清楚记录代码的开发 情况还有一点好处是可以与一个自动文档生成工具 doxygen 兼容自动生成文档描 述。 C++类、结构体及其成员注释规范。类名前一定加入对类的描述风格为/**，类内部 的公共成员一定按下面格式加上注释可以选用/**风格与///风格。对于私有成员一般 用简单注释风格///注释。对于有参数传递的成员函数应该使用/**@param @returnp 这种注释风格。以上注释一般加在.h 头文件中，示例如下： /** * 利用套接字实现异步通信的客户端类 */ class CClient { public: /// 构造函数 CClient(); /// 析构函数 virtual ~CClient();
//----------------------------------------------------------------------void CClient::processData(TRANSDATA *pTransData) { // 若模拟已停止(m_nStatus=0), 除非接收到开始命令或初始化数据或握手信号, 其它不予处理 if( m_nStatus == 0 &&
/** * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* @file
* @author $Autied by $Reworker$
* @version 1.0
* @section Brief
// 暂停命令
{
ControlPanel::getSingletonPtr()->notifyLinc(ControlPanel::LA_PAUSE); } else if (pTransData->nCmd == CMD_RESUME) // 恢复命令
{ ControlPanel::getSingletonPtr()->notifyLinc(ControlPanel::LA_RESUME);
* Modified: 2010/04/17 23:20
*
* 处理.ini文件的读入和写出
*
* Copyright (C) 2008-2010 503 Lab XiDian University.
* All rights reserved.
*
** * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/** * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* @file
* @author WuJiuwei
* @remarks Modified by WuJiuwei
* @version 1.0
* @section Brief
/// <summary> /// 类的构造函数，传递INI文件名 /// </summary> /// <param name="inipath">传入的ini文件名</param> public IniFile(string inipath) {
Path = inipath; }
/// <summary> /// 写INI文件 /// </summary> /// <param name="Section">组名</param> /// <param name="Key">条目名称</param> /// <param name="Value">条目值或内容</param> public void IniWriteValue(string Section, string Key, string Value) {
* @file
* @author LinKai
* @remarks Modified by WuJiuwei
* @version 1.0
* @section Brief
* Modified at: 2010/04/17 22:28
* * 定义网络通信客户端。作为 B 机的数据通信控制
*
* Copyright (C) Infrared Tech. Inst., XiDian Univ.
pTransData->nCmd != CMD_START && pTransData->nCmd != CMD_INIT_DATA &&
pTransData->nCmd != CMD_MODE_DATA && pTransData->nCmd != CMD_CONNECT && pTransData->nCmd != CMD_COORDINATE_REDEFINE ) return;
return null;
{
return null;
} 代码总体缩进依据 vs 编辑器自身处理为准。在 C++代码中通过快捷键 Ctrl+A+K+F
来统一当前全部代码的缩进。在 C#中用 Ctrl+A+E+F 来格式化当前全部代码的缩进。 C#中还可以通过删除代码段的最后一个花括号再重新输入这个花括号的方法完成 局部代码的格式化。
} else if (pTransData->nCmd == CMD_EXPLODE) // 爆炸命令
{ ControlPanel::getSingletonPtr()->notifyLinc(ControlPanel::LA_EXPLODE); // 爆炸
}
(三) C#代码注释规范 在文件中加入代码说明块，格式与 C++的相同。 C#类、结构体及其成员注释规范。类名前一定加入对类的描述风格为/// <summary>。 类 成 员 函 数 与 成 员 变 量 分 别 用 ///<summary> 与 /// 注 释 风 格 。 ///<summary> 风 格 是 visual studio 针对 C#代码自带的格式且与文档自动生成工具 doxygen 兼容。示例代 码如下：
WritePrivateProfileString(Section, Key, Value, this.Path); }……省略代码
程序员自身局部代码注释采用//风格
if (pTransData->nCmd == CMD_CONNECT) // 若是握手信号
{
if (pTransData->nFrom == 0)// 0 indicates the data is form the server(machine A)
………..省略代码
else if (pTransData->nCmd == CMD_PAUSE)
* All rights reserved.
*
** * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ 这 个 代 码 说 明 块 可 以 通 过 visual assist x 的 脚 本 来 辅 助 输 入 。 设 置 方 法 ： option---advance---suggestion---edit va snippets---C++/C#---new 。 输 入 title 为 ： FileHeaderInformation，shortcut 为：fi，内容为：