代码编写规范说明书

代码编写规范说明书（c#.net与https://www.wendangku.net/doc/3b16948181.html,）目录

1 目的

2 范围

3 注释规范

3.1 概述

3.2 自建代码文件注释

3.3 模块（类）注释

3.4 类属性注释

3.5 方法注释

3.6 代码间注释

4 命名总体规则

5 命名规范

5.1 变量（Variable）命名

5.2 常量命名

5.3 类（Class）命名

5.4 接口（Interface）命名

5.5 方法（Method）命名

5.6 名称空间Namespace）命名

6 编码规则

6.1 错误检查规则

6.2 大括号规则

6.3 缩进规则

6.4 小括号规则

6.5 If Then Else规则

6.6 比较规则

6.7 Case规则

6.8 对齐规则

6.9 单语句规则

6.10 单一功能规则

6.11 简单功能规则

6.12 明确条件规则

6.13 选用FALSE规则

6.14 独立赋值规则

6.15 定义常量规则

6.16 模块化规则

6.17 交流规则

7 编程准则

7.1 变量使用

7.2 数据库操作

7.3 对象使用

7.4 模块设计原则

7.5 结构化要求

7.6 函数返回值原则

8 代码包规范

8.1 代码包的版本号

8.2 代码包的标识

9 代码的控制

9.1 代码库/目录的建立

9.2 代码归档

10 输入控制校验规则

10.1 登陆控制

10.2 数据录入控制

附件1：数据类型缩写表

附件2：服务器控件名缩写表

1 目的

一.为了统一公司软件开发设计过程的编程规范

二.使网站开发人员能很方便的理解每个目录,变量，控件，类，方法的意义

三.为了保证编写出的程序都符合相同的规范，保证一致性、统一性而建立的程序编码规范。

四.编码规范和约定必须能明显改善代码可读性，并有助于代码管理、分类范围适用于企业所有基于.NET平台的软件开发工作

2 范围

本规范适用于开发组全体人员，作用于软件项目开发的代码编写阶段和后期维护阶段。

3 注释规范

3.1 概述

a) 注释要求英文及英文的标点符号。

b) 注释中，应标明对象的完整的名称及其用途，但应避免对代码过于详细的描述。

c) 每行注释的最大长度为100个字符。

d) 将注释与注释分隔符用一个空格分开。

e) 不允许给注释加外框。

f) 编码的同时书写注释。

g) 重要变量必须有注释。

h) 变量注释和变量在同一行，所有注释必须对齐，与变量分开至少四个“空格”键。

如：int m_iLevel,m_iCount; // m_iLevel ....tree level

// m_iCount ....count of tree items

string m_strSql; //SQL

i) 典型算法必须有注释。

j) 在循环和逻辑分支地方的上行必须就近书写注释。

k) 程序段或语句的注释在程序段或语句的上一行

l) 在代码交付之前，必须删掉临时的或无关的注释。

m) 为便于阅读代码，每行代码的长度应少于100个字符。

3.2 自建代码文件注释

对于自己创建的代码文件（如函数、脚本），在文件开头，一般编写如下注释：

/******************************************************

FileName:

Copyright (c) 2004-xxxx *********公司技术开发部

Writer:

create Date:

Rewriter:

Rewrite Date:

Impact:

Main Content（Function Name、parameters、returns）

******************************************************/

3.3 模块（类）注释

模块开始必须以以下形式书写模块注释：

///

如果模块只进行部分少量代码的修改时，则每次修改须添加以下注释：

///Rewriter Rewrite Date：<修改日期:格式YYYY-MM-DD> Start1：

/* 原代码内容*/

///End1：

将原代码内容注释掉，然后添加新代码使用以下注释：

///Added by Add date：<添加日期，格式：YYYY-MM-DD> Start2：

///End2：

如果模块输入输出参数或功能结构有较大修改，则每次修改必须添加以下注释：///

3.4 类属性注释

在类的属性必须以以下格式编写属性注释：

///

3.5 方法注释

在类的方法声明前必须以以下格式编写注释

///

/// <参数说明>

///

///<对方法返回值的说明，该说明必须明确说明返回的值代表什么含义>

///

///Writer：作者中文名

///Create Date：<方法创建日期，格式：YYYY-MM-DD>

3.6 代码间注释

代码间注释分为单行注释和多行注释：

//<单行注释>

/*多行注释1

多行注释2

多行注释3*/

代码中遇到语句块时必须添加注释（if,for,foreach,……）,添加的注释必须能够说明此语句块的作用和实现手段（所用算法等等）。

4 命名总体规则

名字应该能够标识事物的特性。

名字一律使用英文单词，而不能为拼音。

名字尽量不使用缩写，除非它是众所周知的。

名字可以有两个或三个单词组成，但不应多于三个，控制在3至30个字母以内。

在名字中，多个单词用大写第一个字母（其它字母小写）来分隔。例如：IsSuperUser。 名字尽量使用前缀而不是后缀。

名字中的单词尽量使用名词，如有动词，也尽量放在后面。例如：FunctionUserDelete（而不是FunctionDeleteUser）。

5 命名规范

5.1 变量（Variable）命名

a) 程序文件(*.cs)中的变量命名

程序中变量名称= 变量的前缀+代表变量含意的英文单词或单词缩写。

类模块级的变量请用“m_” +数据类型缩写作为前缀（其中，m 为“memory”缩写，数据类型缩写见附件中的《数据类型缩写表》）。

public class hello

{

private string m_strName;

private DateTime m_dtDate;

}

类的属性所对应的变量，采用属性名前加“m_”+ 类型缩写前缀的形式

public class hello

{

private string m_strName;

public string Name

{

get

{

return m_strName;

}

}

}

过程级的变量使用类型缩写前缀

public class hello

{

void say()

{

string strSayWord;

}

}

过程的参数使用“p_”+ 类型缩写作为前缀（其中，p 为“parameter”缩写）

public class hello

{

void say(string p_strSayWord)

{

}

}

补充说明：

针对异常捕获过程中的Exception变量命名，在没有冲突的情况下，统一命名为exp；

如果有冲突的情况下，可以用“exp”+ 标志名称，如：expSql。

Try

{

//your code

try

{

//code

}

catch(Exception exp)

{

//your code

}

}

catch(Exception expSql)

{

//your code

}

补充：如果捕获异常不需要作任何处理，则不需要定义Exception实例。

例：

try

{

//your code

}

catch( Exception exp)

{

}

鉴于大多数名称都是通过连接若干单词构造的，请使用大小写混合的格式以简化它们的阅读。每个单词的第一个字母都是大写.

即使对于可能仅出现在几个代码行中的生存期很短的变量，仍然使用有意义的名称。仅对于短循环索引使用单字母变量名，如i 或j。

在变量名中使用互补对，如min/max、begin/end 和open/close。

不要使用原义数字或原义字符串，如For (i = 1;i <= 7;i++)。而是使用命名常数，如For (i = 1;i <= NUM_DAYS_IN_WEEK;i++) 以便于维护和理解。

b) 控件命名

控件命名= 控件名称前二到三个字母+ 名称，如Labl控件（labUserName）

5.2 常量命名

常量名也应当有一定的意义，格式为NOUN 或NOUN_VERB。常量名均为大写，字之间用下划线分隔。

例：

private const bool WEB_ENABLEPAGECACHE_DEFAULT = true;

private const int WEB_PAGECACHEEXPIRESINSECONDS_DEFAULT = 3600;

private const bool WEB_ENABLESSL_DEFAULT = false;

注：

变量名和常量名最多可以包含255 个字符，但是，超过25 到30 个字符的名称比较笨拙。此外，要想取一个有实际意义的名称，清楚地表达变量或常量的用途，25 或30 个字符应当足够了。

5.3 类（Class）命名

a) 名字应该能够标识事物的特性。

b) 名字尽量不使用缩写，除非它是众所周知的。

c) 名字可以有两个或三个单词组成，但通常不应多于三个。

d) 在名字中，所有单词第一个字母大写。例如IsSuperUser，包含ID的，ID全部大写，如CustomerID。

e) 使用名词或名词短语命名类。

f) 少用缩写。

g) 不要使用下划线字符(_)。

例：public class FileStream

public class Button

public class String

5.4 接口（Interface）命名

和类命名规范相同，唯一区别是接口在名字前加上“I”前缀

例：

interface IDBCommand;

interface IButton;

5.5 方法（Method）命名

和类命名规范相同。

5.6 命名空间（NameSpace）命名

和类命名规范相同。

6 编码规则

6.1 错误检查规则

a) 编程中要考虑函数的各种执行情况，尽可能处理所有流程情况。

b) 检查所有的系统调用的错误信息，除非要忽略错误。

c) 将函数分两类：一类为与屏幕的显示无关，另一类与屏幕的显示有关。对于与屏幕显示无关的函数，函数通过返回值来报告错误。对于与屏幕显示有关的函数，函数要负责向用户发出警告，并进行错误处理。

d) 错误处理代码一般放在函数末尾。

e) 对于通用的错误处理，可建立通用的错误处理函数，处理常见的通用的错误。

6.2 大括号规则

将大括号放置在关键词下方的同列处，例如：

if ($condition) while ($condition)

{ {

... ...

} }

6.3 缩进规则

使用一个“Tab”为每层次缩进。例如：

function func()

{

if (something bad)

{

if (another thing bad)

{

while (more input)

{

}

}

}

}

6.4 小括号规则

a) 不要把小括号和关键词（if 、while等）紧贴在一起，要用空格隔开它们。

b) 不要把小括号和函数名紧贴在一起。

c) 除非必要，不要在Return返回语句中使用小括号。因为关键字不是函数，如果小括号紧贴着函数名和关键字，二者很容易被看成是一体的。

6.5 If Then Else规则

如果你有用到else if 语句的话，通常最好有一个else块以用于处理未处理到的其他情况。可以的话放一个记录信息注释在else处，即使在else没有任何的动作。其格式为：

if (条件1) // 注释

{

}

else if (条件2) // 注释

{

}

else // 注释

{

}

注：if 和循环的嵌套最多允许4层

6.6 比较规则

总是将恒量放在等号/不等号的左边。一个原因是假如你在等式中漏了一个等号，语法检查器会为你报错。第二个原因是你能立刻找到数值而不是在你的表达式的末端找到它。例如：if ( 6 == $errorNum ) ...

6.7 Case规则

default case总应该存在，如果不允许到达，则应该保证：若到达了就会触发一个错误。Case 的选择条件最好使用int或string类型。

6.8 对齐规则

变量的申明和初始化都应对齐。例如：

int m_iCount;

int i,j;

float m_fIncome,m_fPay;

m_iCount = 0;

i = 1;

m_fIncome = 0.3;

6.9 单语句规则

除非这些语句有很密切的联系，否则每行只写一个语句。

6.10 单一功能规则

原则上，一个程序单元（函数、例程、方法）只完成一项功能。

6.11 简单功能规则

原则上，一个程序单元的代码应该限制在一页内（25~30行）。

6.12 明确条件规则

不要采用缺省值测试非零值。例如：使用“if ( 0 != f( ) )”而不用“if ( f( ) )”。

6.13 选用FALSE规则

大部分函数在错误时返回FALSE、0或NO之类的值，但在正确时返回值就不定了（不能用一个固定的TRUE、1或YES来代表），因此检测一个布尔值时应该用FALSE、0、NO之类的不等式来代替。例如：使用“if ( FALSE != f( ) )”而不用“if (TRUE == f( ) )”。

6.14 独立赋值规则

嵌入式赋值不利于理解程序，同时可能回造成意想不到的副作用，应尽量编写独立的赋值语句。例如：使用“a = b + c ; e = a + d;”而不用“e = ( a = b + c ) + d ”。

6.15 定义常量规则

对于代码中引用的常量（尤其是数字），应该define成一个大写的名字，在代码中引用名字而不直接引用值。

6.16 模块化规则

某一功能，如果重复实现一遍以上，即应考虑模块化，将它写成通用函数。并向小组成员发布。同时要尽可能利用其它人的现成模块。

6.17 交流规则

共享别人的工作成果，向别人提供自己的工作成果。

在具体任务开发中，如果有其它的编码规则，则在相应的软件开发计划中予以明确定义。

7 编程准则

7.1 变量使用

a) 不允许随意定义全局变量。

b) 一个变量只能有一个用途；变量的用途必须和变量的名称保持一致。

c) 所有变量都必须在类和函数最前面定义，并分类排列。

7.2 数据库操作

a) 查找数据库表或视图时，只能取出确实需要的那些字段。

b) 使用无关联子查询，而不要使用关联子查询。

c) 清楚明白地使用列名，而不能使用列的序号。

d) 用事务保证数据的完整性。

7.3 对象使用

a) 尽可能晚地创建对象，并且尽可能早地释放它。

7.4 模块设计原则

a) 不允许随意定义公用的函数和类。

b) 函数功能单一，不允许一个函数实现两个及两个以上的功能。

c) 不能在函数内部使用全局变量，如要使用全局变量，应转化为局部变量。

d) 函数与函数之间只允许存在包含关系，而不允许存在交叉关系。即两者之间只存在单方向的调用与被调用，不存在双向的调用与被调用。

7.5 结构化要求

a) 禁止出现两条等价的支路。

例如：if (a == 2)

else if (a== 3)

//

else if (a == 2)

//

else

//

b) 避免使用GOTO语句

c) 用IF 语句来强调只执行两组语句中的一组。禁止ELSE GOTO 和ELSE RETURN。

d) 用CASE 实现多路分支

e) 避免从循环引出多个出口。

f) 函数只有一个出口。

g) 不使用条件赋值语句。

h) 避免不必要的分支。

i) 不要轻易用条件分支去替换逻辑表达式

7.6 函数返回值原则

1）函数返回值

避免使用结构体等复杂类型

使用bool类型：该函数只需要获得成功或者失败的返回信息时候

使用int 类型：错误代码用负数表示，成功返回0

8 代码包规范

本项目中，每个任务在完成一个稳定的版本后，都应打包并且归档。

8.1 代码包的版本号

项目中，代码包的版本号由圆点隔开的两个数字组成，第一个数字表示发行号，第二个数字表示该版的修改号。具体用法如下：

1) 当代码包初版时，版本号为V1.00；

2) 当代码包被局部修改或bug修正时，发行号不变，修改号第二个数字增1。例如，对初版代码包作了第一次修订，则版本号为V1.01；

3) 当代码包在原有的基础上增加部分功能，发行号不变，修改号第一个数字增1，例如，对V1.12版的基础上增加部分功能，则新版本号为V1.20；

4) 当代码包有重要修改或局部修订累积较多导致代码包发生全局变化时，发行号增1。例如，在V1.15 版的基础上作了一次全面修改，则新版本号为V2.00。

8.2 代码包的标识

本项目所产生的代码包都有唯一、特定的编码，其构成如下：

S-项目标识-代码包类型-版本号/序号

其中：

1) S：本项目的标识，表明本项目是“XXXX”。

2) 项目标识：简要标识本项目，此标识适用于整个项目的文档。

3) 代码包类型：取自以下表的两位字母编码。

4) 版本号：本代码包的版本号。

5) 序号：四位数字编码，指明该代码包在项目代码库的总序号。

例如：

一个Windows下RAR源码的压缩代码包命名为：S-XXXX-WS-V1.02/0001

项目的代码包分类表

类型编码注释

RAR包

（web）源码文件WS 源代码文件包

编译文件WB 编译文件包

安装文件WI 安装文件包

源码代码+ 安装文件W A 源代码和安装文件包

项目中所有代码包的标识清单将在《项目开发计划》中予以具体定义。

9 代码的控制

9.1 代码库/目录的建立

项目负责人在VSS中建立项目的文档库目录，即为“Software”目录，以便快速查询。9.2 代码归档

所有代码在完成一个稳定的版本后，项目负责人都应打包后，存放于VSS中该目的“Software”目录下，并且依据代码包的命名规范为代码包分配一个唯一名称。

10 输入控制校验规则

10.1 登陆控制

用户登陆ID和登陆密码，要限定输入长度范围，必须检查输入合法性。

10.2 数据录入控制

a) TextBox输入

1、要保持用户输入和数据库接收的长度一致

2、必须进行输入合法性校验

如：E_mail格式XXX@XXX.XXX...

电话格式020-******** (020)12345678

邮政编码是六位

b) 除CheckBox、RadioButton外，禁止在DataGrid内嵌入其他编辑控件，用以添加编辑数据

11. 数据库命名规范:

SqlServer命名规范

使用本系统遵循以下命名规范：

1、表命名：用一个或三个以下英文单词组成，单词首字母大写，如：DepartmentUsers；

2、表主键名称为：表名+ID，如Document表的主键名为：DocumentID

3、存储过程命名：表名+方法,如：p_my_NewsAdd,p_my_NewsUpdate;

4、视图命名：View_表名，如：ViewNews;

5、Status为表中状态的列名，默认值为0，在表中删除操作将会改变Status的值而不真实删除该记录；

6、Checkintime为记录添加时间列，默认值为系统时间；

7、表、存储过程、视图等对象的所有都为dbo，不要使用数据库用户名，这样会影响数据库用户的更改。

附件1：数据类型缩写表

数据类型缩写

string str

int i

char chr

sbyte sb

byte bt

uint ui

long l

ulong ul

float f

double d

bool b

decimal dec

附注：数据库服务器命名规范，控件名缩写+控件作用单词的全称,如：btnNext, txtPassword(密码文本框)，txtRPassword(密码确认文本框)，单词的第一个字母必须大写如果有多个单词，则为控件缩写+控件作用的第一个单词+第二个单词的全称，每个单词名的第一个字母必须大写

附件2：服务器控件名缩写表

a、web控件

web控件名缩写

AdRotator art

Button btn

Calendar cd

CheckBox chk

CheckBoxList chkl

CompareValidator cpv

CustomValidator ctv

DataGrid dg

DataList dl

DropDownList ddl

HyperLink hl

Image img

ImageButton Ibtn

Label lab

LinkButton lbtn

ListBox lst

Panel pl

PlaceHolder ph

RadioButton rb

RadioButtonList rbl

RangeValidator rv

RegularExpressionValidator rev

Repeater rp

RequiredFieldValidator rfv

Table tb

TableCell tc

TableRow tr

TextBox txt

ValidationSummary vs

XML XML

b、html控件

html控件名缩写

HtmlAnchor hah

HtmlButton hbtn

HtmlForm hform HtmlGenericControl hgc HtmlImage himg HtmlInputButton（按钮）htxt HtmlInputButton（重置）hrbtn HtmlInputButton（提交）hcbtn HtmlInputCheckBox hick HtmlInputFile hifile HtmlInputHidden hihidden HtmlInputImage hiimg HtmlInputRadioButton hirb HtmlInputText（密码）hpwd HtmlInputText（文本）hitxt HtmlSelect hslt

HtmlTable htab

HtmlTableCell htc HtmlTableRow htr HtmlTextArea htxta

https://www.wendangku.net/doc/3b16948181.html,控件命名规范

类型前缀示例

Connection con conNorthwind Command cmd cmdReturnProducts Parameter parm parmProductID DataAdapter dad dadProducts DataReader dtr dtrProducts DataSet dst dstNorthWind DataTable dtbl dtblProduct DataRow drow drowRow98 DataColumn dcol dcolProductID DataRelation drel drelMasterDetail DataView dvw dvwFilteredProducts

程序代码注释编写规范

程序代码注释编写规范 为提高控制程序的阅读性与可理解性，现制定相关代码程序代码注释编写的编写规范。 一般情况下，源程序有效注释量必须在20％以上，注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。 常规注释有以下两种方式。 单行:以"//"符号开始，任何位于该符号之后的本行文字都视为注释。 多行:以"/*"符号开始，以"*/"结束。任何介于这对符号之间的文字都视为注释。 一、说明性文件 说明性文件（如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等）头部应进行注释，注释必须列出：版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等，头文件的注释中还应有函数功能简要说明。 示例：下面这段头文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。 /************************************************* COPYRIGHT (C), MicTiVo International. Co., Ltd. File NAME: // 文件 Author: Version: Date: // 作者、版本及完成日期 DESCRIPTION: // 用于详细说明此程序文件完成的主要功能，与其他模块 // 或函数的接口，输出值、取值范围、含义及参数间的控 // 制、顺序、独立或依赖等关系 Others: // 其它内容的说明 Function List: // 主要函数列表，每条记录应包括函数名及功能简要说明 1.... History: // 修改历史记录列表，每条修改记录应包括修改日期、修改 // 者及修改内容简述 1. Date: Author: Modification: 2. .. *************************************************/ 二、源文件头 源文件头部应进行注释，列出：版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。 示例：下面这段源文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。 /************************************************************ COPYRIGHT (C), MicTiVo International. Co., Ltd. FileName: Author:

软件代码编写规范

? 软件销售代理合同范本软件代码编写规范 草稿 2005.2

? 软件销售代理合同范本 1 命名规则 https://www.wendangku.net/doc/3b16948181.html,命名规则 一致的命名模式是托管类库中可预知性与可发现性最重要的元素之一。对这些命名指南广泛的使用和理解将消除许多最常见的用户问题。本主题提供.NET Framework 类型的命名指南。对于每个类型，还应该注意关于大写样式、区分大小写和措词的一些通用规则。 1.1.1大写样式 描述用于在类库中命名标识符的Pascal 大小写、Camel 大小写和全部大写样式。 使用下面的三种大写标识符约定。 Pascal 大小写 将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用Pascal 大小写。例如： B ack C olor Camel 大小写 标识符的首字母小写，而每个后面连接的单词的首字母都大写。例如： b ack C olor 大写 标识符中的所有字母都大写。仅对于由两个或者更少字母组成的标识符使用该约定。例如： System.IO System.Web.UI 可能还必须大写标识符以维持与现有非托管符号方案的兼容性，在该方案中所有大写字母经常用于枚举和常数值。一般情况下，在使用它们的程序集之外这些字符应当是不可见的。 下表汇总了大写规则，并提供了不同类型的标识符的示例。 标识符大小写示例 类Pascal AppDomain 枚举类型Pascal ErrorLevel 枚举值Pascal FatalError 事件Pascal ValueChange 异常类Pascal WebException 注意总是以Exception后缀结尾。 只读的静态字段Pascal RedValue 接口Pascal IDisposable 注意总是以I 前缀开始。 方法Pascal ToString 命名空间Pascal System.Drawing 参数Camel typeName 属性Pascal BackColor

产品使用说明书编写模板

使用说明书模板 根据所需改写即可 远程抄表能源管理系统 使用说明书 XXXXXXXX XXXX 年XX 月 文档控制 修改记录 * 修改类型分为A一Added M—Mod辻ied D—Deleted 审阅人 存档 目录 1醞

1.1背景 1.2应用领域与使用对象 1.4参考资料 1.5术语与缩耳解释 2系统综述 2.1系统结构 2.2系统功能简介 2.3性能 2.4版权声明 3运行环境 3.1硕件设备要求 3.2支持软件 3.3数据结构 4系统操作说明 4.1安装与初始化 4.2子模块名称1 4.2. 1业务需求描述 4. 2. 2界面截屏以及界面字段解释 4. 2. 3操作说明 4. 3子模块名称2 4. 3. 1业务需求描述 4. 3. 2界面截屏以及界面字段解释 4.4出错处理和恢复 4. 3. 3操作说明

1概述

1?1背景 系统的开发背景和编写这个手册的U的。 1.2应用领域与使用对象 描述软件所能使用的领域以及使用对象等。 1.4参考资料 列出有关资料的作者、标题、编号、发表日期、岀版单位或资料来源，可包括 与该产品有关的已发表的资料 文档中所引用的资料，所采用的软件标准或规范或业务规则 列岀编写本说明书时查阅的Internet上杂志、专业著作、技术标准以及他们的网址 1?3术语与缩写解释 2系统综述 4.4出错处理和恢复

2.1系统结构 结合系统所具有的功能包括输入、处理和输出提供该软件的总体结构图表。 2.2系统功能简介 结合本软件的开发实际逐项地说明本软件所有具有各项功能。 2.3性能 给出一般情况下的运行性能指数等。 2.4版权声明 声明版权所有者以及盗版应承当的法律责任。 3运行环境 3.1硬件设备要求 列出本软件所要求的硬设备的最小配置，如： 1、处理器的型号、内存、硬盘容量； 2、所要求的外存储器、媒体、记录格式、设备的型号和台数、联机/脱机; 3、I/O设备（联机/脱机）； 4、数据传输设备和转换设备的型号、台数。 3. 2支持软件

华为JAVA编程规范

1 Java 编程规范 1.1 排版 1.1.1 规则 规则1程序块要采用缩进风格编写，缩进的空格数为4个，不允许使用TAB缩进。(1.42+) 说明：缩进使程序更易阅读，使用空格缩进可以适应不同操作系统与不同开发工具。 规则2分界符（如大括号…{?和…}?）应各独占一行，同时与引用它们的语句左对齐。在函数体的开始、类和接口的定义、以及if、for、do、while、switch、case语句中的程序 或者static、,synchronized等语句块中都要采用如上的缩进方式。(1.42+) 示例: if (a>b) { doStart(); } 规则3较长的语句、表达式或参数（>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐， 语句可读。(1.42+) 示例： if (logger.isDebugEnabled()) { logger.debug("Session destroyed,call-id" + event.getSession().getCallId()); } 规则4不允许把多个短语句写在一行中，即一行只写一条语句(1.42+) 说明：阅读代码更加清晰 示例：如下例子不符合规范。 Object o = new Object(); Object b = null; 规则5if, for, do, while, case, switch, default 等语句自占一行，且if, for, do, while,switch等语句的执行语句无论多少都要加括号{},case 的执行语句中如果定义变量必须加括号{}。 (1.42+) 说明：阅读代码更加清晰，减少错误产生 示例： if (a>b) { doStart(); }

详细设计文档 (含系统说明书,源代码说明书)

东北师范大学 外语培训机构数据库详细设计文档 雷蕾张丽云丁鼎孔祥楠 2009-11-1

目录 第一章引言 (1) 1.1项目说明 (1) 1.2文档目的 (1) 1.3参考资料 (1) 第二章设计流程图 (3) 2.1注册功能流程图 (3) 2.2用户登录功能流程图 (4) 2.3搜索课程功能流程图 (5) 2.3前台用户下载资料或留言功能流程图 (5) 2.3后台管理员功能流程图 (6) 第三章类规格说明 (7) 2.1模块类图 (7) 3.2 jsp页面说明 (8) 3.3类说明 (10) 第四章程序设计说明 (15)

第一章引言 1.1项目说明 1、在互联网络高速发展的今天，网站是企业在因特网上全面介绍公司信息的一个发布平台：可以把任何想让人们知道的东西放入网站，如公司简介、公司的厂房、生产设施、研究机构、产品的外观、功能及其使用方法等，都可以展示于网上。 2、网站树立培训机构形象，让别人看到自己，展示培训机构的实力。培训机构就能够在国内和世界"亮相"，无疑是一种宣传机构、产品和服务的机会。从广告意义上看，培训机构网站事关机构形象建设，没有网站也谈不上机构形象。 3、主动抢占先机，培训机构建设自己的网站，这是时代发展的必然，任何一家培训机构要想跟上时代发展的潮流，必须要有展示自己的一个信息平台。为了不被竞争对手建立网站抢占先机，为了不落后于时代潮流，应该考虑建站的必要性。 4、可以扩大业务范围，可以与潜在客户建立商业联系：这是该网址最重要的功能之一，也是为什么那么多的国外企业非常重视网站建设的根本原因。现在，世界各国大的采购商主要都是利用互联网络来寻找新的产品和新的供应商，因为这样做费用最低，效率最高。原则上，全世界任何地方的人，只要知道了公司的网址，就可以看到公司的产品。因此，关键在于如何将公司网址推介出去。一种非常实用而有效的方法是将公司的网址登记在全球著名的搜索引擎（如Google，百度，雅虎等）上，并选择与公司的产品及服务有关的关键字，则可以使潜在的客户能够容易地找到公司和产品。这正是国际商业上通行的做法，而且被实践证明是十分有效的。 5、给广大热爱外语，渴望了解外语信息的群体提供一个方便快捷的平台。 1.2文档目的 该文档的阅读群体是该项目组的全部成员，为了让所有成员能对本网站的数据库构成，数据流向有个深刻的了解，方便在以后的编程中合理运用。 1.3参考资料 数据库原理及应用教程2版 北京人民邮电出版社 著者：陈志泊王春玲 数据库原理与应用 北京清华大学出版社 著者：狄文辉宋真君白劲波

产品说明书及其编写教案

产品说明书及其编写 高中通用技术技术与设计1 一、教学设计思路 本节课通过学生自主讨论探究、从而发现问题，建构新的知识体系，能够运用新的知识技能解决实际生活中的问题，坚实把握“做中学”和“学中做”的思想，不断地逐步提高学生对通用技术的理解，培养学生自主分析问题的能力，提高学生获取并理解技术知识理论的能力，提高学生应用技术具体分析、解决问题的能力。 1、教材分析 本节课是《普通高中课程标准实验教科书通用技术必修1 技术与设计1》第八单元《技术产品的使用和保养》中第一节《产品说明书及其编写》。作为本单元的入门篇目，要求理解并掌握产品说明书的定义和作用，并准确掌握产品说明书的编写方法，理解产品说明书的一般结构、表述形式、写作要求。本节课是后续课程《技术产品的使用、维护和保养》的基础，如何将产品说明书的编写与实践生活相联系，让技术思想深入学生脑海，是本节课需要攻克的一个难题。 2、学情分析 学生通过学习前面的技术课程，已经具有了一定的技术素养，这就为学习本节课奠定了一些知识基础。学生具有一定的生活和学习基础，产品说明书在他们的生活中处处可见，但对于产品说明书的认识只浮于表面，不够清晰具体，更不理解产品说明书的编写需要注意什么问题。 教材中，开题案例为“说明书表述错误引发卡式炉爆炸”，许多学生没有使用过燃气罐，缺乏亲身实践经历。若只按照教材直接讲授，难以激发学生的积极性，不能调动学生学习兴趣。本节教学应从学生能够理解的身边实例出发，让学生自己分析理解，让产品说明书深入学生的脑海。因此，本节课以自行车车轮的组装为例展开教学，激发学生学习兴趣的同时，巧妙引入产品说明书的课题。 二、教学目标 1、知识与技能：了解产品说明书的定义、作用，了解产品说明书的编写方法，结合简单的案例，能够从技术的角度出发，分别从结构、形式、要求三个方面理解产品说明书的编写。 2、过程与方法：通过观察实物、动手探究等课堂活动，结合典型案例分析，感受所学知识与实际生活的密切关系，能够通过课程内容达到编写简单产品说明书的目的。 3、情感、态度与价值观：通过课堂活动，能够激发学生的学习热情，培养动脑思考问题的良好习惯和小组合作能力的提升。 三、教学重点、难点 教学重点：理解产品说明书的定义与作用，了解说明书的结构、形式及写作要求。 教学难点：结合课程教学内容，编写简单的产品说明书。 四、教学方式、方法 1、案例分析 结合教师、学生提供的案例和课本案例进行分析，通过案例分析，达到知识传授的目

产品使用说明书编写规定

产品使用说明书编写规定 1 本标准规定了产品使用说明书的基本要求和编写方法。 本标准适应于湖北京山轻工机械股份有限公司产品使用说明书的编写。 2 引用标准 下列标准所包含的条文，通过在本标准中引用而构成为本标准的条文。本标准出版 时，所示版本均为有效。所有标准都会被修订，使用本标准的各方应探讨使用下列 标准最新版本的可能性。 工业产品使用说明书总则 JB/T5995 工业产品使用说明书机电产品使用说明书编写规定 3 基本要求 号或不同的字体表示， 或用特殊符号或颜色来强调。 使用说明书必须按下列等级和 告用 语提醒用户： —“危险”表示对高度危险要警惕； 表示对中度危险要警惕； 注意”表示对轻度危险要关注； 使用说明书应明确给出产品用途和适应范围， 并根据产品的特点和需要给出主要结 构、性 能、型式、规格和正确吊运、安装、使用、操作、维修、保养等的方法，以 及保护操作者 和产品的安全措施。 使用说明书内容的表述要科学、合理、符合操作程序，易于用户快速理解掌握。 对于复杂的操作程序，应多采用图示、图表、和操作程序图进行说明。 使用说明书中的图、表应和正文印在一起，图、表应按顺序编写序 3.8 具有几种不同和独 立功能的产品的使用说明书， 应先介绍产品的基本的和通常的功 能，然后再介绍其他方面的功能。 3.9 使用说明书应尽可能设想用户可能遇到的问题，并提供预防和解决的办法。 3.10应使用简明的标题和标注，以帮助用户快速找到所需内容。 3.11使用说明书应将机、电、气、液等融合一起编制，不能各行其是。 3.12外购件的使用说明书应附在相应的产品使用说明书上。编制产品使用说明书时， 除在产品使用说明书中简述其使用、 操作方法外， 还应注明详见某 某使用说 明书。 3.13使用说明书中的符号、代号、术语、计量单位应符合最新发布的国家法令、法规和 有关标 准的规定，并保持前后一致。 3.1 3.2 3.3 3.4 当需要时必须编制产品使用说明书，使用说明书是交付产品的组成部分。 使用说明书的开本幅面采用 16开，大于 16开的幅面应折页成 16 开。多页应装订 成册。 使用说明书可按产品型号编制， 也可按产品系列编制。 复杂产品和成套设备可按功 能单元、整机分别编制使用说明书， 再按产品型号、 用途组合成系统的使用说明书。 使用说明 书应对涉及安全方面的内容给出安全警告。 安全警告的内容应用较大的字 “做小” 3.5 3.6 3.7

程序代码编写规范

程序编写规范及约定 (仅供内部使用) 文档作者：_______________ 日期：___/___/___ 开发/测试经理：_______________ 日期：___/___/___ 项目经理：_______________ 日期：___/___/___ 请在这里输入公司名称 版权所有不得复制

目录 程序编写规范及约定 (3) 1编写目的 (3) 2代码编写风格 (3) 2.1单元风格 (3) 2.2语句风格 (3) 3命名规则 (3) 3.1命名约定 (3) 3.1.1标志符 (3) 3.1.2类class (3) 3.1.3枚举类型enum (4) 3.1.4委托delegate (4) 3.1.5常量const (4) 3.1.6接口interface (4) 3.1.7方法function (4) 3.1.8命名空间namespace (4) 3.1.9参数 (4) 3.1.10局部变量 (5) 3.1.11数据成员 (5) 3.1.12自定义异常类 (5) 3.1.13命名缩写 (5) 3.1.14数据库命名 (5) 3.2代码编写命名规范 (6) 3.3界面常用控件命名约定 (6) 3.4文件命名规范 (7) 3.4.1文档文件命名 (7) 3.4.2配置文件命名 (7) 3.4.3程序文件命名 (7)

程序编写规范及约定 1编写目的 为了使编写代码具有可读性、可理解性、可维护性，对程序编写人员代码实行统一风格，使得程序代码能够以名称反映含义、以形式反映结构。此文档可供程序代码编写人员及代码维护人员使用。 2代码编写风格 2.1单元风格 2.2语句风格 3命名规则 3.1命名约定 Pascal和Camel命名约定： 编程的命名方式主要有Pascal和Camel两种（Pascal：每个单词的首字母大写，例如ProductType；Camel：首个单词的首字母小写，其余单词的首字母大写，例如productType） 3.1.1标志符 规则：Pascal、Camel 实例与描述：例子说明 3.1.2类class 规则：Pascal 实例与描述：Application

51单片机实例(含详细代码说明)

1．闪烁灯 1．实验任务 如图4.1.1所示：在P1.0端口上接一个发光二极管L1，使L1在不停地一亮一灭，一亮一灭的时间间隔为0.2秒。 2．电路原理图 图4.1.1 3．系统板上硬件连线 把“单片机系统”区域中的P1.0端口用导线连接到“八路发光二极管指示模块”区域中的L1端口上。 4．程序设计内容 （1）．延时程序的设计方法 作为单片机的指令的执行的时间是很短，数量大微秒级，因此，我们要 求的闪烁时间间隔为0.2秒，相对于微秒来说，相差太大，所以我们在 执行某一指令时，插入延时程序，来达到我们的要求，但这样的延时程 序是如何设计呢？下面具体介绍其原理：

如图4.1.1所示的石英晶体为12MHz，因此，1个机器周期为1微秒机器周期微秒 MOV R6,#20 2个 2 D1: MOV R7,#248 2个 2 2＋2×248＝498 20× DJNZ R7,$ 2个2×248 (498 DJNZ R6,D1 2个2×20＝40 10002 因此，上面的延时程序时间为10.002ms。 由以上可知，当R6＝10、R7＝248时，延时5ms，R6＝20、R7＝248时， 延时10ms,以此为基本的计时单位。如本实验要求0.2秒＝200ms， 10ms×R5＝200ms，则R5＝20，延时子程序如下： DELAY: MOV R5,#20 D1: MOV R6,#20 D2: MOV R7,#248 DJNZ R7,$ DJNZ R6,D2 DJNZ R5,D1 RET （2）．输出控制 如图1所示，当P1.0端口输出高电平，即P1.0＝1时，根据发光二极管 的单向导电性可知，这时发光二极管L1熄灭；当P1.0端口输出低电平， 即P1.0＝0时，发光二极管L1亮；我们可以使用SETB P1.0指令使P1.0 端口输出高电平，使用CLR P1.0指令使P1.0端口输出低电平。 5．程序框图 如图4.1.2所示

产品说明书的写法

产品说明书的写法 作者:未知来自:百度贴吧点击: 12566 时间:2007-5-29 （一）产品说明书概述 产品说明书，是对商品的性能、用途、使用和保养方法以及注意事项等作书面介绍的文书。产品说明书，又叫商品说明书。产品说明书的作用：助和指导消费者正确地认识商品、使用和保养商品，兼具宣传商品的作用。根据内容和用途的不同：可分为民用产品说明书、专业产品说明书、技术说明书等。根据表达形式的不同：可分为条款式说明书、文字图表说明书等。根据传播方式的不同，可分为：包装式：即直接写在产品的外包装上。内装式：将产品说明书专门印制，甚至装订成册，装在包装箱（盒）内。 （二）产品说明书的特点 ⒈说明性。说明、介绍产品，是主要功能和目的。 ⒉实事求是性。必须客观、准确反映产品。 ⒊指导性。还包含指导消费者使用和维修产品的知识。 ⒋形式多样性。表达形式可以文字式，也可以图文兼备。 （三）产品说明书的结构和写法 ⒈标题。一般是由产品名称加上“说明书”三字构成，如《VCD说明书》。有些说明书侧重介绍使用方法，称为使用说明书，如《吹风机使用说明》。 ⒉正文。通常详细介绍产品的有关知识：产地、原料、功能、特点、原理、规格、使用方法、注意事项、维修保养等知识。不同说明书的内容侧重点也有所不同。一般的产品说明书分为⑴家用电器类。⑵日用生活品类。⑶食品药物类。⑷大型机器设备类。⑸设计说明书。 ⒊附文。厂名、地址、电话、电挂、电传、联系人和生产日期等。出口产品在外包装上写明生产日期、中外文对照。

（四）注意事项： 突出产品特点。要注意广告和说明书的区别。如“喝孔府家酒，做天下文章”可做广告语，写入产品说明书不合适。语言要求准确、通俗、简明。尽可能图文并重。 【案例】 香雪牌抗病毒口服液使用说明书 (纯中药新药) 本品系以板兰根、藿香、连翘、芦根、生地、郁金等中药为原料，用科学方法精心研制而成。是实施新药审批法以来通过的，第一个用于治疗病毒性疾患的纯中药新药。 本品经中山医科大学附属第一医院、第一军医大学南方医院和广州市第二人民医院等单位严格的临床证，证明对治疗上呼吸道炎、支气管炎、流行性出血性结膜炎(红眼病)、腮腺炎等病毒性疾患有显著疗效。总有效率达91．27％。其中，对流行性出血性结膜炎(红眼病)和经病毒分离阳性的上呼吸道炎疗效均为100％，并有明显缩短病程的作用。 本品疗效确切，服用安全、方便，尤其适用于儿童患者，是治疗病毒性疾病的理想药物。 [性状]本品为棕红色液体，味辛，微苦。 [功能与主治]抗病毒药。功效清热祛湿，凉血解毒，用于治疗风热感冒、瘟病发热及上呼吸道感染、流感、腮腺炎等病毒感染疾患。 [用法与用量]口服，一次10ml，一日2～3次，宜饭后服用，小儿酌减。 [注意事项]临床症状较重，病程较长或合并有细菌感染的患者应加服其他治疗药物。 [规格]每支10ml。

产品说明注意事项

工业产品使用说明书的编写方法 一、编写工业产品使用说明书的基本要求 编写工业产品使用说明书应符合下列四个方面基本要求： 1．应明确具体规定产品的用途和使用方法 要根据产品的使用功能和特点，具体而明确地写明产品的用途和适用范围，同时写明主要结构、性能参数、型式和规格以及正确贮运、安装、使用（操作）、维修、保护等方法。 产品使用说明书可按产品型号编写，也可按产品系列编写。 2．涉及到安全、卫生和环境保护等方面要求必须写明 当产品具有危险和有害因素时，必须在产品使用说明书中写明保护产品和操作者的安全卫生措施，对易燃、易爆、有毒、有腐蚀性和有放射性的危险产品，更应在使用说明书上规定防范措施、注意事项以及发生意外时的紧急处理办法等内容。 对影响环境的产品，使用说明书上还应规定必要的保护环境方面的内容。此外，对一些耗能较大产品应说明节能措施。 3．复杂产品和成套设备应编写系统的使用说明书

对一些复杂产品和成套设备，可按其功能单元、整机分别编写使用说明书，再组合成一套系统的使用说明书。 4．简单产品可不写使用说明书 对一些冶金、矿产、建材等原材料类产品以及用于组装配套的一些元器件、零部件等简单产品，如其产品标准、产品手册、质量证明书等有关技术文件能满足用户需要时，可由这些技术文件代管产品使用说明书，不必另行编写产品使用说明书。 二、产品使用说明书的内容构成 一般工业产品使用说明书应包括下列内容： 1．产品概述 产品概述部分主要写明产品的用途，适用范围（必要时还应写明不适用范围），产品规格型号的含义，使用环境条件或工作条件等方面内容。 2．结构特征与工作原理 该部分叙述产品结构特点及其工作原理，包括主要部件或功能单元的结构，作用及其工作原理，辅助装置的功能结构及工作原理和各单元之间的机电联系，故障告警系统等。

程序代码注释编写规范

百度文库- 让每个人平等地提升自我 1 程序代码注释编写规范 为提高控制程序的阅读性与可理解性，现制定相关代码程序代码注释编写的编写规范。 一般情况下，源程序有效注释量必须在20％以上，注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。 常规注释有以下两种方式。 单行:以"文件、.inc文件、.def文件、编译说明文件.cfg等）头部应进行注释，注释必须列出：版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等，头文件的注释中还应有函数功能简要说明。 示例：下面这段头文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。 /************************************************* (C), MicTiVo International. Co., Ltd. 1.File : . History: Date: Author: Modification: 2. .. *************************************************/ 一、源文件头 源文件头部应进行注释，列出：版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。 示例：下面这段源文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。 /************************************************************ (C), MicTiVo International. Co., Ltd. FileName: Author: Version : Date: : / /*receive _process() */ 意:与溢出中断写初值不同}

OSAI系统M代码说明

我们简单的描述那些标准的 M 代码，这些 M 代码在下表中列出。 由于机器建立了控制器和具体应用功能之间的接口以至于你可以自定义一些符合具体应用功能的 M 代码，所 以在你的机器中使用的那些 M 代码可能和下面描述的 M 代码不相同，所以最好还是参考你机器的程序说明书 以获得更多关于每一个具体 M 代码的应用信息。
M 代码 M0 M1 M2 M3 M4 M5 M6 M7 M8 M9 M10 M11 M12 M13 M14 M19 M30 M40 M41 M42 M43 M44 M45 M60 x x x x x x x x x x x x x x x x
前缀激活
后缀激 活 x x x
取消由 周期开始 周期开始 M4-M5-M14-M19 M3-M5-M13-M19 程序停止
含义
可选性的程序停止 程序结束 主轴顺时针 主轴逆时针 主轴停止 刀具转换 辅助冷冻剂开启 主要冷冻剂开启 冷冻剂关闭 轴锁定 轴解锁 旋转轴锁定 主轴顺时针和冷冻剂开启 主轴逆时针和冷冻剂开启 主轴停止在指定角度 程序结束后复位至第程序开始 停用主轴范围
x x
M3-M4-M13-M14 M9 M9
x
M7-M8 M11 M11 M4-M5-M14-M19 M3-M5-M13-M19 M3-M4-M5-M13-M14
x M42-M43-M44-M40 M41-M43-M44-M40 M41-M42-M44-M40 M41-M42-M43-M40 M41-M42-M43-M44 x
主轴范围 1-2-3-4 范围自动改变 部件更换
在 AMP 环境中，你可以指定某些 M 代码可以通过控制器复位来取消。 这个移动可以是点对点(G29)或者连续的(G27-G28)，其取决于 M 是如何被设置的。
M 代码 M0 M1 M2 止，主轴停止和冷却液流动停止。
描述 程序停止：在 M0 出现的程序段，控制器完成了该程序段的所有操作后， M0 便使程序执行停 可选性的程序停止：如果使用合适的软键命令，M1 可像 M0 编码那样使用。 程序结束：M2 定义一个程序的结束。

软件开发代码规范C版

软件开发代码规范（C#版） 拟制:日期：2007-2-13审核:日期： 审核:日期： 批准:日期： 版权所有 ********有限公司

修订纪录

目录 注：Pascal命名法则：即名称中所有单词的第一个字母大写其他字母使用

小写形式。 Camel命名法则：即名称中第一个单词各个字母全部小写，其他部分遵循Pascal命名法则。 1、第一章命名规范 1.1、第一节总则 1．本命名规则除特殊提及外统一使用Camel命名法则。 如：controlMenu 2．命名时尽量不使用拼音，更不可使用拼音缩写（专有名词除外）。 3．如果使用品牌名称命名时其大小写尽量保持和品牌名称一致的样式。 如：LuX则命名时，不要写成LUX，或者Lux，而应该保持与原品牌名称风格一致使用LuX 4．使用专有名词或英文缩写命名时采用大写形式。 如：CNNIC 5．禁止使用仅区分大小写的方式命名。 如：Abc与abc仅用大写A来区分，这样写在类C系语言中不会出错，但是不利于系统的迁移

、第二节变量命名规范 1.2.1、CodeBehind内部命名规范 1．公有字段/属性使用Pascal 命名规则，私有变量/保护变量/局部变量使用Camel命名规则，遵循动宾结构。 例： public class Hello { private string userName; private DateTime loginTime; private bool isOnline; public string UserName { get { return ; } } } 2．即使对于可能仅出现在几个代码行中的生存期很短的变量，仍然使用意义描述性的名称。仅对于短循环索引使用单字母变量名，如 i 或 j 3．在变量名中使用互补对，如 Min/Max、Begin/End 和 Open/Close。 4．当一个方法内部变量繁多的时候，可以使用Camel命名法则，其中第一个单词可以使用变量类型的缩写来说明以示区别。 例：

产品使用说明书编写规定

产品使用说明书编写规定 1本标准规定了产品使用说明书的基本要求和编写方法。 本标准适应于湖北京山轻工机械股份有限公司产品使用说明书的编写。 2引用标准 下列标准所包含的条文，通过在本标准中引用而构成为本标准的条文。本标准出版时，所示版本均为有效。所有标准都会被修订，使用本标准的各方应探讨使用下列标准最新版本的可能性。 GB9969.1 工业产品使用说明书总则 JB/T5995 工业产品使用说明书机电产品使用说明书编写规定 3基本要求 3.1当需要时必须编制产品使用说明书，使用说明书是交付产品的组成部分。 3.2使用说明书的开本幅面采用16开，大于16开的幅面应折页成16开。多页应装订 成册。 3.3使用说明书可按产品型号编制，也可按产品系列编制。复杂产品和成套设备可按功 能单元、整机分别编制使用说明书，再按产品型号、用途组合成系统的使用说明书。 3.4使用说明书应对涉及安全方面的内容给出安全警告。安全警告的内容应用较大的字 号或不同的字体表示，或用特殊符号或颜色来强调。使用说明书必须按下列等级和警告用语提醒用户： —“危险”表示对高度危险要警惕； —“警告”表示对中度危险要警惕； —“注意”表示对轻度危险要关注； 3.5使用说明书应明确给出产品用途和适应范围，并根据产品的特点和需要给出主要结 构、性能、型式、规格和正确吊运、安装、使用、操作、维修、保养等的方法，以及保护操作者和产品的安全措施。 3.6使用说明书内容的表述要科学、合理、符合操作程序，易于用户快速理解掌握。3.7对于复杂的操作程序，应多采用图示、图表、和操作程序图进行说明。 使用说明书中的图、表应和正文印在一起，图、表应按顺序编写序号。 3.8具有几种不同和独立功能的产品的使用说明书，应先介绍产品的基本的和通常的功 能，然后再介绍其他方面的功能。 3.9使用说明书应尽可能设想用户可能遇到的问题，并提供预防和解决的办法。 3.10应使用简明的标题和标注，以帮助用户快速找到所需内容。 3.11使用说明书应将机、电、气、液等融合一起编制，不能各行其是。 3.12外购件的使用说明书应附在相应的产品使用说明书上。编制产品使用说明书时，除 在产品使用说明书中简述其使用、操作方法外，还应注明详见某某使用说明书。 3.13使用说明书中的符号、代号、术语、计量单位应符合最新发布的国家法令、法规和 有关标准的规定，并保持前后一致。 3.14当产品结构、性能等改动时，使用说明书的有关内容必须按规定程序、及时作相应 修改。 4基本内容 4.1封面 封面一般应包括：产品型号、名称、使用说明书字样。 4.2次页

程序代码注释编写规范

程序代码注释编写规范 XXX份公司

为提高控制程序的阅读性与可理解性，现制定相关代码程序代码注释编写的编写规范。 一般情况下，源程序有效注释量必须在20％以上，注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。 常规注释有以下两种方式。 单行:以"//"符号开始，任何位于该符号之后的本行文字都视为注释。 多行:以"/*"符号开始，以"*/"结束。任何介于这对符号之间的文字都视为注释。 一、说明性文件 说明性文件（如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等）头部应进行注释，注释必须列出：版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等，头文件的注释中还应有函数功能简要说明。 示例：下面这段头文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。 /************************************************* COPYRIGHT (C), MicTiVo International. Co., Ltd. File NAME: // 文件 Author: Version: Date: // 作者、版本及完成日期 DESCRIPTION: // 用于详细说明此程序文件完成的主要功能，与其他模块 // 或函数的接口，输出值、取值范围、含义及参数间的控 // 制、顺序、独立或依赖等关系 Others: // 其它内容的说明 Function List: // 主要函数列表，每条记录应包括函数名及功能简要说明 1.... History: // 修改历史记录列表，每条修改记录应包括修改日期、修改 // 者及修改内容简述 1. Date: Author: Modification: 2. .. *************************************************/ 二、源文件头 源文件头部应进行注释，列出：版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。 示例：下面这段源文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。 /************************************************************

代码说明书

系统编码规范 1.目的 为了统一开发过程中关于代码编写时的编写规范和具体开发工作时的编程规范，保证代码的一致性,便于交流和维护，特制定此规范。 2.适用范围 本规范适用于开发组全体人员，为详细设计，代码编写和代码审核提供参考和依据。 3.代码格式 在编写代码过程中，建议遵循以下规则。 （1）缩进规则：使用四个空格作为每层次代码的缩进值。 （2）在括号对对齐的位置垂直对齐左右括号，如： For(i=0;i++) { …. } （3）沿逻辑结构行缩进代码，如：

If…then If…then … Else … End if Else … End if （4）为了防止在阅读代码时左右滚动代码编辑器，每行代码或注释不得超过一个显示屏。 （5）当一行分别为几行时，通过将串联运算符放在每行的末尾而不是开头，清楚地表示没有后面的行是不完整的。 （6）Case 规则：default case 总应该存在，如果不允许到达，则应该保证：若到达了就会触发一个错误。Case的选择条件最好使用int或string类型。 （7）对齐规则：变数的申明和初始化都应对齐。

4.注释规范 4.1. 块注释 //用户名非空 验证+长度验证 +合法性验证 function checkUserName(){ var name = document.myform1.txtUser; if(name.value==""){ alert("请输入用户名"); name.focus(); return false; }else if(name.value.length<4||name.value.length>16){// 用户名长度验证 alert("用户名输入的长度4-16个字符"); name.select(); return false; } 4.2. 行注释 用户名非 空验证+长 度验证+合 法性验证 function checkUserName(){ var name = document.myform1.txtUser; if(name.value==""){ alert("请输入用户名"); name.focus(); return false; }else if(name.value.length<4||name.value.length>16){//用户名 长度验证 alert("用户名输入的长度4-16个字符"); name.select(); return false;

工业产品使用说明书标准(2)

工业产品使用说明书标准 工业产品使用说明书总则 1 基本要求 1.1 使用说明书是交付产品的组成部分. .使用说明书应明确给出产品用途和适用范围,并根据产品的特点和需要给出主要结构,性能参数,型式与规格和正确吊运. 安装.使用.操作.维修.保养 和贮存等方法,以及保护操作者和产品的安全措施. .对影响环境和能源的产品,使用说明书还应规定必要的保护环境和节约能源方面的内容 .对易烧.易爆,有毒.有腐蚀性,有放射性等产品.还应包括防护措施. 注意事 项和发生意外时的紧急处理办法等内容. 1.2 当产品结构,.性能等有改动而影响使用时,使用说明书的有关内容必须

作相应修改. 1.3 使用说明书可按产品型编制,也可按产品系列, 成套性编制.按系列.成套性编制时,其内容和参数不同之部分必须明显区分. .复杂产品和成套设备可按功能单元.整机分别编制使用说明书, 再按产品型号,用途组合成系统的使用说明书. 1.4 冶金.矿产,建材等原材料类产品及用于主机厂配套的元器件等产品,如质量证明书. 产品标准.产品手册等技术文件能满足用户需要时,则可用其代替使用说明书. 2 一般规定 2.1 使用说明书的印制 .使用说明书应能长期使用,保证在产品预期寿命期内的可用性.(批量定型产

品的使用说明书.一般应采用铅印).使用说明书的文字,符号,图示.表格,照 片等应清晰.整齐.双面印制者,不得因透背等原因而影响阅视. 2.2 使用说明书的文本 .使用说明书的开本幅面,一般应附合下列规定. a.铅印本:64开(92mm*12mm) 32开(130mm*184mm) 16开(188mm*260mm) 必要时采用其他幅面尺寸,但应符合GB788的规定. b.晒印本:A4号图纸(210mm*297mm)表格. 图形等允许向横向加长.确属必要时方可向纵向加长.数量多的大幅面附图. 附表可分装 .使用说明书根据内容多少可为单页.折页和多页.多页应装订成册. .供给国内用户的工业产品必须有汉文使用说明书, 出品工业产品一般应编

C语言编写规范之注释

1、头文件包含Includes 2、私有类型定义 Private typedef 3、私有定义Private define 4、私有宏定义 Private macro 5、私有变量 Private variables 6、私有函数原型Private function prototypes 7、私有函数Private functions 8、私有函数前注释 /****************************************************************************** * * Function Name : FSMC_NOR_Init * Description : Configures the FSMC and GPIOs to interface with the NOR memory. * This function must be called before any write/read operation * on the NOR. * Input : None * Output : None * Return : None ******************************************************************************* / 9、程序块采用缩进风格编写，缩进空格为4。 10、相对独立的程序块之间、变量说明之后必须加空行； 11、较长的字符（>80字符）要分成多行书写，长表达式要在低优先级操作符划分新行，操作符放在新行之首，新行要恰当缩进，保持排版整齐； 12、循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首; 13、若函数或过程中的参数较长，则要进行适当的划分。 14、不允许把多个短语句写在一行中，即一行只写一条语句。 15、if、for、do、while、case、switch、default等语句自占一行，且if、for、 do、while等语句的执行语句部分无论多少都要加括号{}。 16、对齐只使用空格键，不使用TAB键； 17、 函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格，case 语句下的情况处理语句也要遵从语句缩进要求 18、 程序块的分界符（如C/C++语言的大括号‘{’和‘}’）应各独占一行并且位于同一 列，同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以 及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。 19、 在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或