开发规范编码排版注释规范.docx

上传人:b****8 文档编号:9400229 上传时间:2023-02-04 格式:DOCX 页数:10 大小:18.97KB
下载 相关 举报
开发规范编码排版注释规范.docx_第1页
第1页 / 共10页
开发规范编码排版注释规范.docx_第2页
第2页 / 共10页
开发规范编码排版注释规范.docx_第3页
第3页 / 共10页
开发规范编码排版注释规范.docx_第4页
第4页 / 共10页
开发规范编码排版注释规范.docx_第5页
第5页 / 共10页
点击查看更多>>
下载资源
资源描述

开发规范编码排版注释规范.docx

《开发规范编码排版注释规范.docx》由会员分享,可在线阅读,更多相关《开发规范编码排版注释规范.docx(10页珍藏版)》请在冰豆网上搜索。

开发规范编码排版注释规范.docx

开发规范编码排版注释规范

 

软件开发规范

《试行版》

Version1.0

《编程语言开发规范》

 

2004-6-3

1排版

¹1-1:

程序块要采用缩进风格编写,缩进的空格数为4个。

要求:

使用编辑器提供的tab设置功能,设置为4;绝对不允许使用4个空格字符

¹1-2:

不允许把多个短语句写在一行中,即一行只写一条语句。

示例:

如下例子不符合规范。

rect.length=0;rect.width=0;

应如下书写

rect.length=0;

rect.width=0;

¹1-3:

较长的语句(页宽>80字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读。

示例:

perm_count_msg.head.len=NO7_TO_STAT_PERM_COUNT_LEN

+STAT_SIZE_PER_FRAM*sizeof(_UL);

act_task_table[frame_id*STAT_TASK_CHECK_NUMBER+index].occupied

=stat_poi[index].occupied;

act_task_table[taskno].duration_true_or_false

=SYS_get_sccp_statistic_state(stat_item);

report_or_not_flag=((taskno

&&(n7stat_stat_item_valid(stat_item))

&&(act_task_table[taskno].result_data!

=0));

¹1-4:

if、for、do、while、case、switch、default等语句自占一行,且if、for、do、while等语句的执行语句部分无论多少都要加括号{}。

示例:

如下例子不符合规范。

if(pUserCR==null)return;

应如下书写:

if(pUserCR==null){

return;

}

¹1-5:

函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格,case语句下的情况处理语句也要遵从语句缩进要求。

¹1-6:

程序块的分界符(如大括号‘{’和‘}’)应各独占一行并且位于同一列,同时与引用它们的语句左对齐。

在函数体的开始、类的定义、结构的定义以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。

示例:

如下例子不符合规范。

if(...)

{

...//programcode

}

voidexample_fun(void)

{

...//programcode

}

应如下书写。

for(...)

{

...//programcode

}

if(...)

{

...//programcode

}

voidexample_fun(void)

{

...//programcode

}

2注释

¹2-1:

一般情况下,源程序有效注释量必须在20%以上。

说明:

注释的原则是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也不能太少,注释语言必须准确、易懂、简洁。

¹2-2:

文件头部应进行注释,注释必须列出:

版权说明、版本号、生成日期、作者、内容、功能、修改日志等.

示例:

建议所有文件使用该格式;java文件使用javadoc要求的格式

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

Copyright(C),1988-1999,YOEEInfoTech.Co.,Ltd.

Filename:

//文件名

Author:

Version:

Date:

//作者、版本及完成日期

Description:

//用于详细说明此程序文件完成的主要功能,与其他模块

//或函数的接口,输出值、取值范围、含义及参数间的控

//制、顺序、独立或依赖等关系

Others:

//其它内容的说明

History:

//修改历史记录列表,每条修改记录应包括修改日期、修改

//者及修改内容简述

#DateAuthorModification

1

2

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

¹2-3:

函数头部应进行注释,列出:

函数的目的/功能、输入参数、输出参数、返回值、调用关系(函数、表)等。

示例:

建议所有文件使用该格式;java文件使用javadoc要求的格式

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

Description:

//函数功能、性能等的描述

Pre-Conditions:

//前置条件

Param:

//输入参数说明,包括每个参数的作用、取值说明及参数间关系。

Return:

//函数返回值的说明

Others:

//其它说明

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

¹2-4:

边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。

不再有用的注释要删除。

要求:

每8行内,必须要有一条注释

¹2-5:

注释的内容要清楚、明了,含义准确,防止注释二义性。

说明:

错误的注释不但无益反而有害。

2-6:

避免在注释中使用缩写,特别是非常用缩写。

说明:

在使用缩写时或之前,应对缩写进行必要的说明。

¹2-7:

注释应与其描述的代码相近,对代码的注释应放在其上方或右方(对单条语句的注释)相邻位置,不可放在下面,如放于上方则需与其上面的代码用空行隔开。

示例:

如下例子不符合规范。

例1:

/*getreplicatesubsystemindexandnetindicator*/

 

repssn_ind=ssn_data[index].repssn_index;

repssn_ni=ssn_data[index].ni;

例2:

repssn_ind=ssn_data[index].repssn_index;

repssn_ni=ssn_data[index].ni;

/*getreplicatesubsystemindexandnetindicator*/

应如下书写

//getreplicatesubsystemindexandnetindicator

repssn_ind=ssn_data[index].repssn_index;

repssn_ni=ssn_data[index].ni;

¹2-8:

注释与所描述内容进行同样的缩排。

说明:

可使程序排版整齐,并方便注释的阅读与理解。

示例:

如下例子,排版不整齐,阅读稍感不方便。

voidexample_fun(void)

{

/*codeonecomments*/

CodeBlockOne

/*codetwocomments*/

CodeBlockTwo

}

应改为如下布局。

voidexample_fun(void)

{

/*codeonecomments*/

CodeBlockOne

/*codetwocomments*/

CodeBlockTwo

}

¹2-9:

将注释与其上面的代码用空行隔开。

示例:

如下例子,显得代码过于紧凑。

/*codeonecomments*/

programcodeone

/*codetwocomments*/

programcodetwo

应如下书写

/*codeonecomments*/

programcodeone

/*codetwocomments*/

programcodetwo

¹2-10:

对变量的定义和分支语句(条件分支、循环语句等)必须编写注释。

说明:

这些语句往往是程序实现某一特定功能的关键,对于维护人员来说,良好的注释帮助更好的理解程序,有时甚至优于看设计文档。

示例:

if(…)//注释

{

}

else//注释

{

}

2-11:

避免在一行代码或表达式的中间插入注释。

说明:

除非必要,不应在代码或表达中间插入注释,否则容易使代码可理解性变差。

2-12:

在程序块的结束行右方加注释标记,以表明某程序块的结束。

说明:

当代码段较长,特别是多重嵌套时,这样做可以使代码更清晰,更便于阅读。

示例:

参见如下例子。

if(...)

{

//programcode

while(index

{

//programcode

}/*endofwhile(index

}/*endofif(...)*///指明是哪条if语句结束

3命名

¹3-1:

JAVA命名规范

-Package的命名

Package的名字应该都是由一个小写单词组成。

-Class的命名

Class的名字必须由大写字母开头而其他字母都小写的单词组成

-接口的命名

与类名命名方式一致,但在该类名的前面增减大写字母“I”,表示接口的意思。

-方法的命名

方法名是一个动词,采用大小写混合的方式,第一个单词的首字母小写,其后单词的首字母大写。

如:

run();runFast();getBackground()

-Class变量的命名

变量的名字必须用一个小写字母开头。

后面的单词用大写字母开头。

变量名不应以下划线或美元符号开头(尽管这在语法上是允许的)。

变量名应简短且富于描述。

变量名的选用应该易于记忆,即,能够指出其用途。

尽量避免单个字符的变量名,除非是一次性的临时变量。

临时变量通常被取名为i,j,k,m和n,它们一般用于整型;c,d,e,它们一般用于字符型。

-StaticFinal变量的命名

StaticFinal变量的名字应该都大写,并且指出完整含义。

-参数的命名

参数的名字必须和变量的命名规范一致。

-数组的命名

数组应该总是用下面的方式来命名:

byte[]buffer;而不是:

bytebuffer[];

-方法的参数

使用有意义的参数命名,如果可能的话,使用和要赋值的字段一样的名字:

SetCounter(intsize){

this.size=size;

}

¹3-2:

页文件、文件夹命名及管理

命名原则:

用代表其含义的英文单词、以及数字表示,不易翻译的用关键字拼音,字母要统一用小写,不得含空格和特殊字符(下划线和破折号除外),最好不要超过8个字符。

管理原则:

系统相关及目录、文件实行统一管理。

个人不能随意创建和修改目录。

原则上,相近的内容放在同一目录下。

1.文件夹命名

●根据功能或文件类型定义文件夹,例如:

css、script、images、public_prompt_info……

●根据网站频道定义文件夹,例如:

首页(homepage)、我的行程(myjourney)

2.文件命名

●网页命名

文件名用代表其含义的英文单词、以及数字表示,不易翻译的用关键字拼音。

首页以default命名,保存根目录下。

●被引用文件的命名(本身不是一个完整的网页,可被其它页面引用)

被引入文件统一放在统一文件夹下(如:

include),命名规则为:

如果被引用文件被多个频道引用则

public_功能.ext 例如:

“菜单”public_menu.inc或public_menu.js

如果被单个频道引用则

频道_功能.ext例如:

“会员注册”member_register.inc

●文件的存放

遵循“管理原则”,另外:

1.游易首页放在最外层文件夹,其它频道首页放在频道文件夹内。

2.频道内的网页放在频道文件夹内。

¹3-3:

图片命名

如果图片只被某一个页面或被引用文件使用,命名规则为:

网页名_图片编号.ext  或  被引用文件名_图片编号.ext

如果公用图片使用,命名规则为

public_图片编号.ext

展开阅读全文
相关资源
猜你喜欢
相关搜索

当前位置:首页 > 外语学习 > 韩语学习

copyright@ 2008-2022 冰豆网网站版权所有

经营许可证编号:鄂ICP备2022015515号-1