1 / 17
文档名称:

代码书写规范.doc

格式:doc   大小:201KB   页数:17页
下载后只包含 1 个 DOC 格式的文档,没有任何的图纸或源代码,查看文件列表

如果您已付费下载过本站文档,您可以点这里二次下载

分享

预览

代码书写规范.doc

上传人:bb21547 2018/9/10 文件大小:201 KB

下载得到文件列表

代码书写规范.doc

文档介绍

文档介绍:符号命名规则符号名包括:模块名,变量名,常量名,方法(函数/子程序)名,数据区名,缓冲区名等。符号命名通常应遵循以下规则:通用规则:1、在所有命名中,都应使用标准的英文单词或缩写。不得使用拼音或拼音缩写,除非该名字描述的是中文特有的内容,如半角、全角,声母、韵母等。2、所有命名都应遵循达意原则,即名称应含义清晰、明确。3、所有命名都不易过长,应控制在规定的最大长度以内。4、所有命名都应尽量使用全称。5、如果命名使用缩写,则必须对其进行注释和说明。具体规范:1、工程名统一制订。2、文件名 文件名应与类名相同,这是java的规范3、方法名/函数名·方法名第一个单词小写。·推荐使用动宾结构。方法名应清晰反映该方法的功能、用途。·方法名最长不得超过30个字符。例:getCollection();setCollection();insertObject();deleteObject();3、变量名必须使用有意义的变量名。推荐的类型缩写(type)——·char:ch·boolean:b·int:i·long:l·double:d·float:f变量名最长不得超过20个字符。4、类名·必须以大写字母开头,类名反映具体含义,以清晰表达类的用途和功能为原则·当名称由多个单词构成时,每一个单词的第一个字母必须大写代码书写规范书写规范即在编写代码过程中所使用的标准格式,主要包括空格的使用、括号的使用、缩近格式和其他一些内容。/.jsp的开头应有一段格式统一的说明,内容包括:(Title/FileName);(Author);(Date);、用途(Description/Function)。样例:/***标题: *描述: 用来实现计划项目审批*创建: 2001-06-30*作者: 赵文正*详细: 详细描述计划项目审批的细节,如何根据细节功能确定方法*/,否则对函数应有注释说明。内容包括:功能、入口/出口参数,必要时还可有备注或补充说明。,最长不得超过120列;折行以对齐为准。,其他类的成员函数可做简短说明。,应注释说明。例:floatgetValue(intID,booleanflag){/*parameterdescriptionID:IdentifyNoflag:default=TRUE*/…}。‘{’、‘}’有关的各项规定: ‘{’、‘}’应独占一行。在该行内可有注释。例:正确:for(i=0;i<Line;i++){//.....("Line="+i+”value=”+Lines[i]);}不得写做:for(i=0;i<cb;i++){("Line="+i+”value=”+Lines[i]);}‘{’必须另起一行,‘{’之后的代码必须缩进一个Tab。‘{’与‘}’必须在同一列上。例:正确:if(i>0){m=1;n++;}不得写做:if(i>0){m=1;n++;}在循环、分支之后若只有一行代码,虽然可省略‘{’、‘}’,但不推荐这么做。若省略后可能引起歧义,则必须加上‘{’、‘}’。例:正确:if(n==-2){n=1;}elseif(n!=nTemp){n=2;}else{n=3;}不得写做:if(n==-2)n=1;elseif(n!=nTemp)n=2;elsen=3;。所有两目、三目运算符的两边都必须有空格。在单目运算符两端不必空格。但在‘.’、‘[’、‘]’等运算符前后,及‘&’(取地址)等运算符之后不得有空格。例:正确:intn=0,nTemp;for(inti=nMinLine;i<=nMaxLine;i++)不得写做:intn=0,nTemp;for(inti=nMinLine;i<=nMaxLine;i++)or、while、if等关键词之后应有1个空格,再接‘(’,之后无空格;在结尾的‘)’前不得有空格。例:正确:if(-2==n)不得写做:if(-2==n)或if(-2==n)等等。调用函数时,‘(’、‘)’前后不得有空格。类型强制转换时,‘(’‘)’①缩进以Tab为单位。1个Tab为4个空格②下列情况,代码缩进一个Tab:函数体相对函数名及‘{’、‘}’。if、else、for、while、do等之后的代码。一行之内写不下,折行之后的代码,应在合理的位置进行折行。若有+-*/等运算符,则运算符应在上一行末尾,而不应在下一行的

最近更新

工会模式可行性分析报告 31页

复合肥可行性分析报告 44页

口腔行业可行性分析报告 33页

分析技术方案可行性分析报告 31页

2024年抖音容易上热门的句子(精选800句) 70页

2024年漳州卫生职业学院单招职业技能测试题库.. 112页

青海光伏项目可行性报告 38页

酵素加工可行性分析报告 37页

道路扩宽项目可行性报告 37页

2024年承包饭堂合同范本15篇 55页

医药商业战略市场规划报告 74页

2024年托管老师岗位职责(精选8篇) 9页

2024年大学计算机基础考试题库带答案(研优卷.. 28页

2024年大学计算机基础考试题库含完整答案(有.. 27页

2024年大学计算机基础考试题库带答案(综合题.. 28页

2024年大学计算机基础考试题库及参考答案(培.. 27页

2024年房屋租赁经纪合同范本 11页

2024年房屋租赁合同纠纷起诉状6篇 11页

2024年大学计算机基础考试题库及参考答案【典.. 28页

白酒的项目可行性报告 42页

电子商品项目可行性报告 33页

2024年房屋出售协议书四篇 6页

2024年大学计算机基础考试题库附答案【典型题.. 28页

2024年大学计算机基础考试题库及完整答案(夺.. 27页

2024年大学计算机基础考试题库精品【实用】 27页

2024年大学计算机基础考试题库及完整答案(有.. 28页

2024年大学计算机基础考试题库(名师推荐) 28页

酸奶制作及营养成分分析课件 21页

乡镇卫生院常见病门诊和住院诊疗规范 66页

七年级下血液测试 1页