📄 华为软件编程规范和范例.htm
字号:
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-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'">
Function: // </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'">
Calls: // </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'"> Called
By: // </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'"> Table Accessed: //
</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'"> Table Updated: //
</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'">
Input: // </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'">
Output: // </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'">
Return: // </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'">*************************************************/</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-5</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-6</SPAN><SPAN
style="FONT-FAMILY: 宋体">：注释的内容要清楚、明了，含义准确，防⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -