📄 华为软件编程规范和范例.htm
字号:
style="MARGIN-LEFT: 24pt; LINE-HEIGHT: 150%; TEXT-ALIGN: left"
align=left><SPAN lang=EN-US style="FONT-FAMILY: 'Courier New'">p->id =
pid; // "->"</SPAN><SPAN
style="FONT-FAMILY: 宋体">指针前后不加空格</SPAN> </P>
<P class=MsoNormal
style="MARGIN-LEFT: 24pt; LINE-HEIGHT: 150%; TEXT-ALIGN: left"
align=left><SPAN lang=EN-US style="FONT-FAMILY: 'Courier New'">(5)
if</SPAN><SPAN style="FONT-FAMILY: 宋体">、</SPAN><SPAN lang=EN-US
style="FONT-FAMILY: 'Courier New'">for</SPAN><SPAN
style="FONT-FAMILY: 宋体">、</SPAN><SPAN lang=EN-US
style="FONT-FAMILY: 'Courier New'">while</SPAN><SPAN
style="FONT-FAMILY: 宋体">、</SPAN><SPAN lang=EN-US
style="FONT-FAMILY: 'Courier New'">switch</SPAN><SPAN
style="FONT-FAMILY: 宋体">等与后面的括号间应加空格，使</SPAN><SPAN lang=EN-US
style="FONT-FAMILY: 'Courier New'">if</SPAN><SPAN
style="FONT-FAMILY: 宋体">等关键字更为突出、明显。</SPAN></P>
<P class=MsoNormal
style="MARGIN-LEFT: 24pt; LINE-HEIGHT: 150%; TEXT-ALIGN: left"
align=left><SPAN lang=EN-US style="FONT-FAMILY: 'Courier New'">if (a >=
b && c > d)</SPAN></P>
<P class=a4 style="MARGIN-LEFT: 0cm; TEXT-INDENT: 0cm"><SPAN lang=EN-US
style="FONT-WEIGHT: normal; FONT-FAMILY: 'Times New Roman'">½</SPAN><SPAN
lang=EN-US>1-1</SPAN><SPAN style="FONT-FAMILY: 宋体">：一行程序以小于</SPAN><SPAN
lang=EN-US style="FONT-FAMILY: 'Courier New'">80</SPAN><SPAN
style="FONT-FAMILY: 宋体">字符为宜，不要写得过长。</SPAN><SPAN lang=EN-US
style="FONT-FAMILY: 'Courier New'"> </SPAN></P></DIV><SPAN
lang=EN-US
style="FONT-SIZE: 10.5pt; LINE-HEIGHT: 150%; FONT-FAMILY: Arial"><BR
style="PAGE-BREAK-BEFORE: always" clear=all></SPAN>
<DIV class=Section3>
<H1><SPAN lang=EN-US style="FONT-FAMILY: 'Courier New'">2 </SPAN><SPAN
style="FONT-FAMILY: 宋体">注释</SPAN></H1>
<P class=a3 style="MARGIN-LEFT: 0cm; TEXT-INDENT: 0cm"><SPAN lang=EN-US
style="FONT-FAMILY: 'Times New Roman'">¹</SPAN><SPAN
lang=EN-US>2-1</SPAN><SPAN
style="FONT-FAMILY: 宋体">：一般情况下，源程序有效注释量必须在</SPAN><SPAN
lang=EN-US>20</SPAN><SPAN style="FONT-FAMILY: 宋体">％以上。</SPAN></P>
<P class=MsoNormal
style="MARGIN-LEFT: 24pt; LINE-HEIGHT: 150%; TEXT-ALIGN: left"
align=left><SPAN
style="FONT-FAMILY: 宋体">说明：注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。</SPAN></P>
<P class=a3 style="MARGIN-LEFT: 0cm; TEXT-INDENT: 0cm"><SPAN lang=EN-US
style="FONT-FAMILY: 'Times New Roman'">¹</SPAN><SPAN
lang=EN-US>2-2</SPAN><SPAN style="FONT-FAMILY: 宋体">：说明性文件（如头文件</SPAN><SPAN
lang=EN-US>.h</SPAN><SPAN style="FONT-FAMILY: 宋体">文件、</SPAN><SPAN
lang=EN-US>.inc</SPAN><SPAN style="FONT-FAMILY: 宋体">文件、</SPAN><SPAN
lang=EN-US>.def</SPAN><SPAN style="FONT-FAMILY: 宋体">文件、编译说明文件</SPAN><SPAN
lang=EN-US>.cfg</SPAN><SPAN
style="FONT-FAMILY: 宋体">等）头部应进行注释，注释必须列出：版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等，头文件的注释中还应有函数功能简要说明。</SPAN></P>
<P class=MsoNormal
style="MARGIN-LEFT: 24pt; LINE-HEIGHT: 150%; TEXT-ALIGN: left"
align=left><SPAN
style="FONT-FAMILY: 宋体">示例：下面这段头文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。</SPAN></P>
<P class=MsoNormal
style="MARGIN-LEFT: 24pt; LINE-HEIGHT: 150%; TEXT-ALIGN: left"
align=left><SPAN lang=EN-US
style="FONT-FAMILY: 'Courier New'">/*************************************************</SPAN></P>
<P class=MsoNormal
style="MARGIN-LEFT: 24pt; LINE-HEIGHT: 150%; TEXT-ALIGN: left"
align=left><SPAN lang=EN-US style="FONT-FAMILY: 'Courier New'">
Copyright (C), 1988-1999, Huawei Tech. Co., Ltd.</SPAN></P>
<P class=MsoNormal
style="MARGIN-LEFT: 24pt; LINE-HEIGHT: 150%; TEXT-ALIGN: left"
align=left><SPAN lang=EN-US style="FONT-FAMILY: 'Courier New'"> File
name: // </SPAN><SPAN
style="FONT-FAMILY: 宋体">文件名</SPAN></P>
<P class=MsoNormal
style="MARGIN-LEFT: 24pt; LINE-HEIGHT: 150%; TEXT-ALIGN: left"
align=left><SPAN lang=EN-US style="FONT-FAMILY: 'Courier New'">
Author:
Version: Date: // </SPAN><SPAN
style="FONT-FAMILY: 宋体">作者、版本及完成日期</SPAN></P>
<P class=MsoNormal
style="MARGIN-LEFT: 24pt; LINE-HEIGHT: 150%; TEXT-ALIGN: left"
align=left><SPAN lang=EN-US style="FONT-FAMILY: 'Courier New'">
Description: // </SPAN><SPAN
style="FONT-FAMILY: 宋体">用于详细说明此程序文件完成的主要功能，与其他模块</SPAN></P>
<P class=MsoNormal
style="MARGIN-LEFT: 24pt; LINE-HEIGHT: 150%; TEXT-ALIGN: left"
align=left><SPAN lang=EN-US
style="FONT-FAMILY: 'Courier New'">
// </SPAN><SPAN
style="FONT-FAMILY: 宋体">或函数的接口，输出值、取值范围、含义及参数间的控</SPAN></P>
<P class=MsoNormal
style="MARGIN-LEFT: 24pt; LINE-HEIGHT: 150%; TEXT-ALIGN: left"
align=left><SPAN lang=EN-US
style="FONT-FAMILY: 'Courier New'">
// </SPAN><SPAN style="FONT-FAMILY: 宋体">制、顺序、独立或依赖等关系</SPAN></P>
<P class=MsoNormal
style="MARGIN-LEFT: 24pt; LINE-HEIGHT: 150%; TEXT-ALIGN: left"
align=left><SPAN lang=EN-US style="FONT-FAMILY: 'Courier New'">
Others: // </SPAN><SPAN
style="FONT-FAMILY: 宋体">其它内容的说明</SPAN></P>
<P class=MsoNormal
style="MARGIN-LEFT: 24pt; LINE-HEIGHT: 150%; TEXT-ALIGN: left"
align=left><SPAN lang=EN-US style="FONT-FAMILY: 'Courier New'">
Function List: // </SPAN><SPAN
style="FONT-FAMILY: 宋体">主要函数列表，每条记录应包括函数名及功能简要说明</SPAN></P>
<P class=MsoNormal
style="MARGIN-LEFT: 24pt; LINE-HEIGHT: 150%; TEXT-ALIGN: left"
align=left><SPAN lang=EN-US
style="FONT-FAMILY: 'Courier New'"> 1. ....</SPAN></P>
<P class=MsoNormal
style="MARGIN-LEFT: 24pt; LINE-HEIGHT: 150%; TEXT-ALIGN: left"
align=left><SPAN lang=EN-US style="FONT-FAMILY: 'Courier New'">
History: // </SPAN><SPAN
style="FONT-FAMILY: 宋体">修改历史记录列表，每条修改记录应包括修改日期、修改</SPAN></P>
<P class=MsoNormal
style="MARGIN-LEFT: 24pt; LINE-HEIGHT: 150%; TEXT-ALIGN: left"
align=left><SPAN lang=EN-US
style="FONT-FAMILY: 'Courier New'">
// </SPAN><SPAN style="FONT-FAMILY: 宋体">者及修改内容简述</SPAN><SPAN lang=EN-US
style="FONT-FAMILY: 'Courier New'"> </SPAN></P>
<P class=MsoNormal
style="MARGIN-LEFT: 24pt; LINE-HEIGHT: 150%; TEXT-ALIGN: left"
align=left><SPAN lang=EN-US
style="FONT-FAMILY: 'Courier New'"> 1. Date:</SPAN></P>
<P class=MsoNormal
style="MARGIN-LEFT: 24pt; LINE-HEIGHT: 150%; TEXT-ALIGN: left"
align=left><SPAN lang=EN-US
style="FONT-FAMILY: 'Courier New'">
Author:</SPAN></P>
<P class=MsoNormal
style="MARGIN-LEFT: 24pt; LINE-HEIGHT: 150%; TEXT-ALIGN: left"
align=left><SPAN lang=EN-US
style="FONT-FAMILY: 'Courier New'">
Modification:</SPAN></P>
<P class=MsoNormal
style="MARGIN-LEFT: 24pt; LINE-HEIGHT: 150%; TEXT-ALIGN: left"
align=left><SPAN lang=EN-US
style="FONT-FAMILY: 'Courier New'"> 2. ...</SPAN></P>
<P class=MsoNormal
style="MARGIN-LEFT: 24pt; LINE-HEIGHT: 150%; TEXT-ALIGN: left"
align=left><SPAN lang=EN-US
style="FONT-FAMILY: 'Courier New'">*************************************************/</SPAN></P>
<P class=a3 style="MARGIN-LEFT: 0cm; TEXT-INDENT: 0cm"><SPAN lang=EN-US
style="FONT-FAMILY: 'Times New Roman'">¹</SPAN><SPAN
lang=EN-US>2-3</SPAN><SPAN
style="FONT-FAMILY: 宋体">：源文件头部应进行注释，列出：版权说明、版本号、生成日期、作者、模块目的</SPAN><SPAN
lang=EN-US>/</SPAN><SPAN
style="FONT-FAMILY: 宋体">功能、主要函数及其功能、修改日志等。</SPAN></P>
<P class=MsoNormal
style="MARGIN-LEFT: 24pt; LINE-HEIGHT: 150%; TEXT-ALIGN: left"
align=left><SPAN
style="FONT-FAMILY: 宋体">示例：下面这段源文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。</SPAN></P>
<P class=MsoNormal
style="MARGIN-LEFT: 24pt; LINE-HEIGHT: 150%; TEXT-ALIGN: left"
align=left><SPAN lang=EN-US
style="FONT-FAMILY: 'Courier New'">/************************************************************</SPAN></P>
<P class=MsoNormal
style="MARGIN-LEFT: 24pt; LINE-HEIGHT: 150%; TEXT-ALIGN: left"
align=left><SPAN lang=EN-US style="FONT-FAMILY: 'Courier New'">
Copyright (C), 1988-1999, Huawei Tech. Co., Ltd.</SPAN></P>
<P class=MsoNormal
style="MARGIN-LEFT: 24pt; LINE-HEIGHT: 150%; TEXT-ALIGN: left"
align=left><SPAN lang=EN-US style="FONT-FAMILY: 'Courier New'">
FileName: test.cpp</SPAN></P>
<P class=MsoNormal
style="MARGIN-LEFT: 24pt; LINE-HEIGHT: 150%; TEXT-ALIGN: left"
align=left><SPAN lang=EN-US style="FONT-FAMILY: 'Courier New'">
Author: Version
: Date:</SPAN></P>
<P class=MsoNormal
style="MARGIN-LEFT: 24pt; LINE-HEIGHT: 150%; TEXT-ALIGN: left"
align=left><SPAN lang=EN-US style="FONT-FAMILY: 'Courier New'">
Description: // </SPAN><SPAN
style="FONT-FAMILY: 宋体">模块描述</SPAN><SPAN lang=EN-US
style="FONT-FAMILY: 'Courier New'">
</SPAN></P>
<P class=MsoNormal
style="MARGIN-LEFT: 24pt; LINE-HEIGHT: 150%; TEXT-ALIGN: left"
align=left><SPAN lang=EN-US style="FONT-FAMILY: 'Courier New'">
Version: // </SPAN><SPAN
style="FONT-FAMILY: 宋体">版本信息</SPAN></P>
<P class=MsoNormal
style="MARGIN-LEFT: 24pt; LINE-HEIGHT: 150%; TEXT-ALIGN: left"
align=left><SPAN lang=EN-US style="FONT-FAMILY: 'Courier New'">
Function List: // </SPAN><SPAN
style="FONT-FAMILY: 宋体">主要函数及其功能</SPAN></P>
<P class=MsoNormal
style="MARGIN-LEFT: 24pt; LINE-HEIGHT: 150%; TEXT-ALIGN: left"
align=left><SPAN lang=EN-US
style="FONT-FAMILY: 'Courier New'"> 1.
-------</SPAN></P>
<P class=MsoNormal
style="MARGIN-LEFT: 24pt; LINE-HEIGHT: 150%; TEXT-ALIGN: left"
align=left><SPAN lang=EN-US style="FONT-FAMILY: 'Courier New'">
History: // </SPAN><SPAN
style="FONT-FAMILY: 宋体">历史修改记录</SPAN></P>
<P class=MsoNormal
style="MARGIN-LEFT: 24pt; LINE-HEIGHT: 150%; TEXT-ALIGN: left"
align=left><SPAN lang=EN-US
style="FONT-FAMILY: 'Courier New'">
<author> <time> <version >
<desc></SPAN></P>
<P class=MsoNormal
style="MARGIN-LEFT: 24pt; LINE-HEIGHT: 150%; TEXT-ALIGN: left"
align=left><SPAN lang=EN-US
style="FONT-FAMILY: 'Courier New'">
David 96/10/12
1.0 build this moudle </SPAN></P>
<P class=MsoNormal
style="MARGIN-LEFT: 24pt; LINE-HEIGHT: 150%; TEXT-ALIGN: left"
align=left><SPAN lang=EN-US
style="FONT-FAMILY: 'Courier New'">***********************************************************/</SPAN></P>
<P class=MsoNormal
style="MARGIN-LEFT: 24pt; LINE-HEIGHT: 150%; TEXT-ALIGN: left"
align=left><SPAN style="FONT-FAMILY: 宋体">说明：</SPAN><SPAN lang=EN-US
style="FONT-FAMILY: 'Courier New'">Description</SPAN><SPAN
style="FONT-FAMILY: 宋体">一项描述本文件的内容、功能、内部各部分之间的关系及本文件与其它文件关系等。</SPAN><SPAN
lang=EN-US style="FONT-FAMILY: 'Courier New'">History</SPAN><SPAN
style="FONT-FAMILY: 宋体">是修改历史记录列表，每条修改记录应包括修改日期、修改者及修改内容简述。</SPAN></P>
<P class=a3 style="MARGIN-LEFT: 0cm; TEXT-INDENT: 0cm"><SPAN lang=EN-US
style="FONT-FAMILY: 'Times New Roman'">¹</SPAN><SPAN
lang=EN-US>2-4</SPAN><SPAN
style="FONT-FAMILY: 宋体">：函数头部应进行注释，列出：函数的目的</SPAN><SPAN
lang=EN-US>/</SPAN><SPAN
style="FONT-⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -