- 1、本文档共24页,可阅读全部内容。
- 2、原创力文档(book118)网站文档一经付费(服务费),不意味着购买了该文档的版权,仅供个人/单位学习、研究之用,不得用于商业用途,未经授权,严禁复制、发行、汇编、翻译或者网络传播等,侵权必究。
- 3、本站所有内容均由合作方或网友上传,本站不对文档的完整性、权威性及其观点立场正确性做任何保证或承诺!文档内容仅供研究参考,付费前请自行鉴别。如您付费,意味着您自己接受本站规则且自行承担风险,本站不退款、不进行额外附加服务;查看《如何避免下载的几个坑》。如果您已付费下载过本站文档,您可以点击 这里二次下载。
- 4、如文档侵犯商业秘密、侵犯著作权、侵犯人身权等,请点击“版权申诉”(推荐),也可以打举报电话:400-050-0827(电话支持时间:9:00-18:30)。
查看更多
(绩效考核)J编码规范(附考核内容)
Java编码规范
修订历史记录
日期
版本
说明
作者
审核人
2011-7-11
0.0.1
对Java代码风格、注释、命名、声明等规范进行描述
黎建宁
2011-8-5
0.0.2
根据征询意见对Java编码规范进行修订
黎建宁、冯彬杰、张史沛、李思行
2011-8-16
0.0.3
对规范中出现模糊定义的地方进行细化描述
黎建宁
2011-9-13
0.0.4
根据编码的约定情况,对注释、声明部分进行了补充
黎建宁、李思行
2011-9-
0.0.
对方法的声明顺序进行补充
黎建宁、李思行
壹简介
1目的
本规范的目的是使开发人员以标准的、规范的方式编写代码,养成良好的编码风格和习惯,形成公司内部编码约定,提高程序的可读性,可维护性以及壹致性,同时减少项目组成员间技术沟通成本,提高团队开发效率。
2范围
1、本文档基于Java1.5的语法描述编码规范。
2、本文档从代码风格、注释、命名、声明以及异常处理等五个方面对Java编码进行约定。
3、本规范适用于所有运用Java技术的软件项目、产品。
4、本规范适用的文件类型包括但不限于Java源文件、JSP文件、XML文件、HTML文件、JS文件以及AS文件。
5、本规范建议采用统壹的CodeStyle以及Formatter风格,通过IDE进行配置。
3读者范围
1、软件过程改进领导小组以及工作小组所有人员;
2、所有运用Java技术的软件项目、产品的关联领导、项目负责人、设计人员、开发人员以及测试人员。
3、所有涉及运用Java技术的软件项目、产品的关联人员。
二代码风格
1缩进
1、使用空格代替Tab缩进,避免各种编辑器中见到不壹样的代码格式。【注:强制执行,Eclipse可辅助排版】
2、代码按层级缩进,每层级缩进4个字符(对于特定格式文件,能够按照实际进行调整,如XML文件可缩进2个字符),所有“{}”块内容均应该进行缩进。【注:强制执行,Eclipse可辅助排版】
参考例子:
2括号
1、除数组的初始化定义外,“{}”中的语句应单独作为壹行。。【注:强制执行,Eclipse可辅助排版】
2、左括号“{”可根据开发习惯是否换行存放,如果换行存放,必须和其前导语句首字符对齐,右括号“}”必须作为单独壹行存放且且和匹配行对齐(即左括号前导语句首字符)。。【注:强制执行,Eclipse可辅助排版】
3、于项目内部,相同类型的文件,其括号的风格必须统壹。。【注:强制执行,Eclipse可辅助排版】
参考例子:
3空格
1、操作符俩端必须带有空格符。【注:强制执行,Eclipse可辅助排版】
参考例子:
2、各且行元素(如函数参数)间以空格符隔开,空格符放于逗号后方。
参考例子:【注:强制执行,Eclipse可辅助排版】
3、无特别要求,括号“{}”、“[]”、“()”左右方尽量不要增加无必要性的空格符。【注:强制执行,Eclipse可辅助排版】
参考例子:
4空行
1、同壹个编译单元间(包定义、导入声明、类)应以空行相隔。
参考例子:【注:强制执行,Eclipse可辅助排版】
2、类定义内部各元素间(字段定义、方法)应以空行相隔。
参考例子:【注:强制执行,Eclipse可辅助排版】
3、同壹方法内实现不同的功能之间应以空行相隔。【注:强制执行】
4、不能无理由出现大片空行。【注:强制执行】
5控制语句
1、对于循环控制等元素块,不管是否带有body,均应该以{}包含。
参考例子:【注:强制执行】
6行宽
1、每行代码尽量控制行宽于100字以内,当超出100字时候,代码应当进行缩进。【注:非强制执行,属加分项】
2、方法的缩进应当保证参数对齐。【注:非强制执行,属加分项】
参考例子:
3、对于过长的SQL/HQL语句,则采用关键字对齐方式,具体可通过PL/SQL等工具进行代码的格式化。【注:非强制执行,属加分项,附带《sql规范》壹且考核】
参考例子:
7类、函数
1、每个函数的代码长度应尽量控制于50行以内(不包含注释),如果函数功能过于庞大,可把独立的功能段单独抽取出来作为子函数。【注:非强制执行,属加分项】
2、每个类的代码长度应尽量控制于1000行以内(不包含注释),如果类功能过于庞大,可通过组合的方式来分解类。【注:非强制执行,属加分项】
三注释
1基本原则
1、注释目的于于增加代码清晰度,使代码易于被其他开发人员理解。【注:强制执行】
2、保持注释简洁,禁止为了注释而注释。【注:强制执行】
3、注释除带有代码功能外,仍应带有描述上下文意图,具体描述其原因。
4、除变量定义等较短语句的注释可用行尾注释外,其他注释当避免使用行尾注释。
5、对描述较长的注释,应当使用HTML标记进行格式化,便于生成的JavaDoc易阅读和理解。【
您可能关注的文档
- (绩效管理方案)员工考核方案.doc
- (绩效管理方案)袁庄中学教职工绩效考核实施方案.doc
- (绩效管理方案)岳源乡卫生院绩效考核方案.doc
- (绩效管理方案)运营总部绩效考核与激励方案.doc
- (绩效管理方案)长沙市雨花区中小学校绩效考核方案.doc
- (绩效管理方案)制造部薪资考核方案.doc
- (绩效管理方案)质量管理工作考核方案.doc
- (绩效管理方案)中层管理人员考核与聘任方案.doc
- (绩效管理方案)中都公司的绩效考核方案(徐剑).doc
- (绩效管理方案)中都公司的绩效考核方案.doc
- 班级元旦晚会策划书 班级元旦晚会策划书4篇.doc
- 班会会议记录格式及 班会会议记录(实用【7篇】.doc
- 认真学习《中国共产党纪律处分条例》PPT党的六大纪律课件.pptx
- 党纪学习教育PPT新修订的《中国共产党纪律处分条例》解读课件.pptx
- 关于严明党的纪律和规矩的重要论述PPT课件.pptx
- 2024年国九条PPT关于加强监管防范风险推动资本市场高质量发展的若干意见课件.pptx
- 2024干部一定要知敬畏存戒惧守底线PPT相关重要论述课件.pptx
- 推动经济实现质的有效提升和量的合理增长PPT学习教育课件.pptx
- 2024坚持“四步联动”做实党员教育工作PPT新时代党员教育工作课件.pptx
- 权威解读《关于加强社区工作者队伍建设的意见》PPT课件.pptx
文档评论(0)