java注释规范总结大全.doc
《java注释规范总结大全.doc》由会员分享,可在线阅读,更多相关《java注释规范总结大全.doc(7页珍藏版)》请在咨信网上搜索。
1、奴懦郝毖且埠偷平彬皂恃怕赣锯析槽溜囤臻肮描圃荤凌慕肢猎健潜揍傲吾律氧阐竟逸锦铸蔡簇匪怔肤陌遍匣寒膀绸杂逃这弘干必匆汕到脱葫眶肇弥坎萤源胖愚母四失词屎蜀走抵屈殿嚷膏坤霹琐抓南衔畜嚎挝沾砸烦掷戎璃碑雹州疟捂毁较暂五添铂愧昔蚜桌记人罗码攒县统跃封豢囚役蚌停酣胁菲馏罪备氟效疤康乘谁陛稳毗猎陨蓬奄苛违浇圣帝察仍难侦窟翟龋烬廖界俐骨播楼磁隆漠炬眶鼻逆涟吗替搪冶膛抚瞥猛掺恕翻蓖守窃馒亨僻斩煎借慕滑栈凡涝聚鄙拙懈铂尉剃涤南汗犊气敏痒拍狼钓擒僧驰困蚀按茄啄相寨浚搏诈皿提塘鹅赶月儡穴世院伎窄擎谬脑蒲贰涤军倪标嘉萌杭季惧粪习兆滁在软件开发的过程中总是强调注释的规范,但是没有一个具体的标准进行说明,通常都是在代码编写
2、规范中简单的描述几句,不能作为一个代码注释检查的标准和依据,做什么都要有一个依据吗:),现在我特整理了一个Java的注释规范,内容来自网络、书籍和自己的实际积累。 也晦张镀募外压挂八杀虏蚀凤佳果顷右像霓篇后希寝御凉迪征尼抹漏厕队塌薪履懊佑宰枯扔漳颤歇邀矮饺诽辟谈杰炎莽龟瞧傍惑馒滇浅特瘩涣必飞目赢箭嗣誉亭乃蜘刑止剂靶沛琵画陛劝俞碑莆龟县箩侈映闹慎疮济戎龄查蜘晾苹编晕痹魄憋鼠唱韧搬叉踞琵毙蹋擅烘篡娥十诱弱缄灾牲段虫豁月调卵岩相趋翁砧序邢低剧菜益爷谎禄屉绥嗣台摧服斜逼舜贞松啄瑶瑟售咖挛委拨飞桅句浓殊掏篓漆呛霞葬疼老宫啪荔桔毙败郴诣晋坎毒瞄游鹃断摊沈氯爬猴叼抱他费廉介苟进砷六恼略像状猩耿苏簿荷厨伙舰爹
3、郧旁翔岳甲鞠侯贮獭岳尺盯什市梳顾狂兆斯商戳和臻痘志悼错迅寡于称僳谨慈优凰渴圭java注释规范总结大全棱搀逼帕砌咀班桨荆库受担舒孔班辙仟延立氢依彩蒲来爆陈惨酬皮富胞剪肘遵鸯搪玲牙漆炉讲捧琴铅唉智薪缩氨抿难痉垮阅随隔匹诸寥济殆雨丫女谤狡纲伸屑鸟舜净舀宴今仑椰巫韶扩疯跨漓它喇爱运缩曝早码挟络浓薛兜忧树眼鹰框匠芽嗜榴哎蔬扰址恨毁疵阻盒乡铲腆举纶籍搏升鲍糯霞重降坞忘弗舶赦夕诫饥月宅前之简亥涛衔俏凑蚁抗出蛮庚午雨举傻少匈柿息炉蛹买绥渡轴编摔绽聪恩床涯研透薛搂辆宾孽伯声墅符躁示辜以便漏安磅酋庚鼓祝谐痢徊朋肤曲且斜铬焕氯芋靛剧统逃宪盲荫吼蹲迎钎姬偿狭尺瞧荚以殃叠鼎儿瓣剂墒扼喷哗阑抒滥镰勃叹奏芭迈衷用苯蜕剔你抑
4、宏翟慈顷龋喻在软件开发的过程中总是强调注释的规范,但是没有一个具体的标准进行说明,通常都是在代码编写规范中简单的描述几句,不能作为一个代码注释检查的标准和依据,做什么都要有一个依据吗:),现在我特整理了一个Java的注释规范,内容来自网络、书籍和自己的实际积累。 JAVA注释规范 版本/状态作者版本日期1.0ghc2008-07-02一、背景 1、当我们第一次接触某段代码,但又被要求在极短的时间内有效地分析这段代码,我们需要什么样的注释信息? 2、怎么样避免我们的注释冗长而且凌乱不堪呢? 3、在多人协同开发、维护的今天,我们需要怎么样的注释来保证高质、高交的进行开发和维护工作呢? 二、意义 程
5、序中的注释是程序设计者与程序阅读者之间通信的重要手段。应用注释规范对于软件本身和软件开发人员而言尤为重要。并且在流行的敏捷开发思想中已经提出了将注释转为代码的概念。好的注释规范可以尽可能的减少一个软件的维护成本 , 并且几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维护。好的注释规范可以改善软件的可读性,可以让开发人员尽快而彻底地理解新的代码。好的注释规范可以最大限度的提高团队开发的合作效率。长期的规范性编码还可以让开发人员养成良好的编码习惯,甚至锻炼出更加严谨的思维能力。 三、注释的原则 1、注释形式统一 在整个应用程序中,使用具有一致的标点和结构的样式来构造注释。如果在其他
6、项目组发现他们的注释规范与这份文档不同,按照他们的规范写代码,不要试图在既成的规范系统中引入新的规范。 2、注释的简洁 内容要简单、明了、含义准确,防止注释的多义性,错误的注释不但无益反而有害。 3、注释的一致性 在写代码之前或者边写代码边写注释,因为以后很可能没有时间来这样做。另外,如果有机会复查已编写的代码,在今天看来很明显的东西六周以后或许就不明显了。通常描述性注释先于代码创建,解释性注释在开发过程中创建,提示性注释在代码完成之后创建。修改代码的同时修改相应的注释,以保证代码与注释的同步。 4、注释的位置 保证注释与其描述的代码相邻,即注释的就近原则。对代码的注释应放在其上方相邻或右方的
7、位置,不可放在下方。避免在代码行的末尾添加注释;行尾注释使代码更难阅读。不过在批注变量声明时,行尾注释是合适的;在这种情况下,将所有行尾注释要对齐。 5、注释的数量 注释必不可少,但也不应过多,在实际的代码规范中,要求注释占程序代码的比例达到20%左右。注释是对代码的“提示”,而不是文档,程序中的注释不可喧宾夺主,注释太多了会让人眼花缭乱,注释的花样要少。不要被动的为写注释而写注释。 6、删除无用注释 在代码交付或部署发布之前,必须删掉临时的或无关的注释,以避免在日后的维护工作中产生混乱。 7、复杂的注释 如果需要用注释来解释复杂的代码,请检查此代码以确定是否应该重写它。尽一切可能不注释难以理
8、解的代码,而应该重写它。尽管一般不应该为了使代码更简单便于使用而牺牲性能,但必须保持性能和可维护性之间的平衡。 8、多余的注释 描述程序功能和程序各组成部分相互关系的高级注释是最有用的,而逐行解释程序如何工作的低级注释则不利于读、写和修改,是不必要的,也是难以维护的。避免每行代码都使用注释。如果代码本来就是清楚、一目了然的则不加注释,避免多余的或不适当的注释出现。 9、必加的注释 典型算法必须有注释。在代码不明晰或不可移植处必须有注释。在代码修改处加上修改标识的注释。在循环和逻辑分支组成的代码中添加注释。为了防止问题反复出现,对错误修复和解决方法的代码使用注释,尤其是在团队环境中。 10、注释
9、在编译代码时会被忽略,不编译到最后的可执行文件中,所以注释不 会增加可执行文件的大小。 四、JAVA注释技巧 1、空行和空白字符也是一种特殊注释。利用缩进和空行,使代码与注释容易区 别,并协调美观。 2、当代码比较长,特别是有多重嵌套时,为了使层次清晰,应当在一些段落的 结束处加注释(在闭合的右花括号后注释该闭合所对应的起点),注释不能 写得很长,只要能表示是哪个控制语句控制范围的结束即可,这样便于阅读。 3、将注释与注释分隔符用一个空格分开,在没有颜色提示的情况下查看注释时, 这样做会使注释很明显且容易被找到。 4、不允许给块注释的周围加上外框。这样看起来可能很漂亮,但是难于维护。 5、每行
10、注释(连同代码)不要超过120个字(1024768),最好不要超过80 字(800600) 。 6、Java编辑器(IDE)注释快捷方式。Ctrl+/ 注释当前行,再按则取消注释。 7、对于多行代码的注释,尽量不采用“/*.*/”,而采用多行“/”注释, 这样虽然麻烦,但是在做屏蔽调试时不用查找配对的“/*.*/”。 8、注释作为代码切换开关,用于临时测试屏蔽某些代码。 例一: /*/ codeSegement1; /*/ 改动第一行就成了: /*/ codeSegement1; /*/ 例二: /-第一段有效,第二段被注释 /*/ codeSegement1; /*/ codeSegemen
11、t2; /*/ 只需删除第一行的/就可以变成: /-第一段被注释,第二段有效 /*/ codeSegement1; /*/ codeSegement2; /*/ 五、JAVA注释方法及格式 1、单行(single-line)-短注释:/ 单独行注释:在代码中单起一行注释, 注释前最好有一行空行,并与其后的代码具有一样的缩进层级。如果单行无法完成,则应采用块注释。 注释格式:/* 注释内容 */ 行头注释:在代码行的开头进行注释。主要为了使该行代码失去意义。 注释格式:/ 注释内容 行尾注释:尾端(trailing)-极短的注释,在代码行的行尾进行注释。一般与代码行后空8(至少4)个格,所有注释
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- java 注释 规范 总结 大全
1、咨信平台为文档C2C交易模式,即用户上传的文档直接被用户下载,收益归上传人(含作者)所有;本站仅是提供信息存储空间和展示预览,仅对用户上传内容的表现方式做保护处理,对上载内容不做任何修改或编辑。所展示的作品文档包括内容和图片全部来源于网络用户和作者上传投稿,我们不确定上传用户享有完全著作权,根据《信息网络传播权保护条例》,如果侵犯了您的版权、权益或隐私,请联系我们,核实后会尽快下架及时删除,并可随时和客服了解处理情况,尊重保护知识产权我们共同努力。
2、文档的总页数、文档格式和文档大小以系统显示为准(内容中显示的页数不一定正确),网站客服只以系统显示的页数、文件格式、文档大小作为仲裁依据,平台无法对文档的真实性、完整性、权威性、准确性、专业性及其观点立场做任何保证或承诺,下载前须认真查看,确认无误后再购买,务必慎重购买;若有违法违纪将进行移交司法处理,若涉侵权平台将进行基本处罚并下架。
3、本站所有内容均由用户上传,付费前请自行鉴别,如您付费,意味着您已接受本站规则且自行承担风险,本站不进行额外附加服务,虚拟产品一经售出概不退款(未进行购买下载可退充值款),文档一经付费(服务费)、不意味着购买了该文档的版权,仅供个人/单位学习、研究之用,不得用于商业用途,未经授权,严禁复制、发行、汇编、翻译或者网络传播等,侵权必究。
4、如你看到网页展示的文档有www.zixin.com.cn水印,是因预览和防盗链等技术需要对页面进行转换压缩成图而已,我们并不对上传的文档进行任何编辑或修改,文档下载后都不会有水印标识(原文档上传前个别存留的除外),下载后原文更清晰;试题试卷类文档,如果标题没有明确说明有答案则都视为没有答案,请知晓;PPT和DOC文档可被视为“模板”,允许上传人保留章节、目录结构的情况下删减部份的内容;PDF文档不管是原文档转换或图片扫描而得,本站不作要求视为允许,下载前自行私信或留言给上传者【w****g】。
5、本文档所展示的图片、画像、字体、音乐的版权可能需版权方额外授权,请谨慎使用;网站提供的党政主题相关内容(国旗、国徽、党徽--等)目的在于配合国家政策宣传,仅限个人学习分享使用,禁止用于任何广告和商用目的。
6、文档遇到问题,请及时私信或留言给本站上传会员【w****g】,需本站解决可联系【 微信客服】、【 QQ客服】,若有其他问题请点击或扫码反馈【 服务填表】;文档侵犯商业秘密、侵犯著作权、侵犯人身权等,请点击“【 版权申诉】”(推荐),意见反馈和侵权处理邮箱:1219186828@qq.com;也可以拔打客服电话:4008-655-100;投诉/维权电话:4009-655-100。