java编程规范与注释课件

《java编程规范与注释课件》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、Java程序设计ProgramminginJava雍俊海清华大学软件学院SchoolofSoftware,TsinghuaUniversityyongjunhai@tsinghua.org.cn6/18/20211教材雍俊海.Java程序设计教程.北京:清华大学出版社,2007.6/18/20212习题集雍俊海.Java程序设计习题集(含参考答案).北京:清华大学出版社,2006.6/18/20213参考文献本课件的参考文献与下面书的参考文献相同雍俊海.Java程序设计教程.北京:清华大学出版社,2007.雍俊海.Java程序设计习题集(含参考答案).

2、北京:清华大学出版社,2006.雍俊海.Java程序设计.北京:清华大学出版社,2004.6/18/20214第10章编程规范和程序调试雍俊海(Jun-HaiYong)清华大学软件学院SchoolofSoftware,TsinghuaUniversityyongjunhai@tsinghua.org.cn6/18/20215本章总体纲要编程规范文档注释程序调试6/18/20216Java编程风格的指导方针指导方针是可以被打破，但要求是确实所需要的，例如增加可读性没有标准可以做到完美无缺，也没有标准可以做到适用于所有的应用指导方针一般是为了:增加可读性、

3、程序的可理解性，从而提高程序的可维护性以及程序代码质量6/18/20217命名规范良好的命名规范可以增强程序的可读性可以给标识符提供功能/属性上的一些额外信息—例如:是否是常量、类、包等。这些信息对理解程序非常有帮助6/18/20218问题?命名规范应当包含哪些内容?6/18/20219命名规范内容包文件类/接口方法变量常量6/18/202110包的命名规范包的名称一般全部采用小写包名的前缀一般是域名单词序列的逆序示例com.sun.engcom.apple.quicktimeedu.cmu.cs.bovik.cheese6/18/202111文件的命

4、名规范Java源程序文件的命名规范必须与该文件中public类的类名同名后缀必须是.java6/18/202112类/接口的命名规范类名一般是名词/名词词组:每个单词的首字母大写，其它字母小写类名应当尽量简单，而且其含义能够尽量准确地刻画该类的含义一般采用全称—尽量少用缩写词(除非该缩写词被广泛使用)示例J_ClockJ_CircleTimeImageSprite(图版精灵)6/18/202113方法的命名规范方法名一般是/动词/动词性词组,首字母小写中间单词的首字母大写，其它字母小写示例:run();getBackground();getTime()

5、;6/18/202114尽量应用常用词尽量应用简单的、常用的单词示例:get/setfirst/lastadd/removeup/downcreate/destroymin/maxstart/stopnext/previousinsert/deleteold/newincrement/decrementopen/closeold/newshow/hidebegin/end6/18/202115变量的命名规范变量名的首字母小写中间单词的首字母大写，其它字母小写变量名的首字母尽量不要用字符:_或$变量名应当简短、有含义、且便于记忆示例:inti;charc

6、;doublewidthBox;6/18/202116变量的命名规范变量名常常由表示其所扮演的角色与数据类型组成示例:PointstartingPoint,centerPoint;NameloginName;6/18/202117常量的命名规范常量名一般全大写，单词之间用下划线分隔(“_”)示例:staticfinalintMIN_WIDTH=4;staticfinalintMAX_WIDTH=999;6/18/202118编辑方法特殊字符行数/每行的字符数缩排方式(Indentation)空白符/行6/18/202119语句书写——关键保证代码的简单

7、性6/18/202120文件组织源程序文件一般采用如下的组织顺序:最开始一般是注释package和import语句类和接口的定义6/18/202121本章总体纲要编程规范文档注释程序调试6/18/202122javadocJavadoc是一种从文档注释生成HTML帮助文件的工具文档注释介于/**和*/之间示例/**SortsintegerarrayusingMySortalgorithm*/6/18/202123文档注释的一般格式示例:/***Thisisthedescriptionpartofadoccomment**@tagCom

8、mentforthetag*/6/18/202124常用的javadoc文档标签@author