Java程序设计Programming in Java

教材:雍俊海.《Java程序设计》.北京:清华大学出版社,2008.2020/2/161Java程序设计ProgramminginJava雍俊海清华大学软件学院SchoolofSoftware,[e-mail]教材:雍俊海.《Java程序设计》.北京:清华大学出版社,2008.2020/2/162教材•雍俊海.Java程序设计.北京:清华大学出版社,2008.教材:雍俊海.《Java程序设计》.北京:清华大学出版社,2008.2020/2/163辅助教材•雍俊海.Java程序设计教程（第2版）.北京:清华大学出版社,2007.教材:雍俊海.《Java程序设计》.北京:清华大学出版社,2008.2020/2/164习题集•雍俊海.Java程序设计习题集(含参考答案).北京:清华大学出版社,2006.教材:雍俊海.《Java程序设计》.北京:清华大学出版社,2008.2020/2/165参考文献•本课件的参考文献与下列书的参考文献相同–雍俊海.Java程序设计.北京:清华大学出版社,2008.–雍俊海.Java程序设计教程（第2版）.北京:清华大学出版社,2007.–雍俊海.Java程序设计习题集(含参考答案).北京:清华大学出版社,2006.–雍俊海.Java程序设计.北京:清华大学出版社,2004.教材:雍俊海.《Java程序设计》.北京:清华大学出版社,2008.2020/2/166第10章编程规范雍俊海(Jun-HaiYong)清华大学软件学院SchoolofSoftware,[e-mail]教材:雍俊海.《Java程序设计》.北京:清华大学出版社,2008.2020/2/167本章总体纲要•编程规范•文档注释教材:雍俊海.《Java程序设计》.北京:清华大学出版社,2008.2020/2/168Java编程风格的指导方针•指导方针是可以被打破，但要求是确实所需要的，例如增加可读性–没有标准可以做到完美无缺，也没有标准可以做到适用于所有的应用–指导方针一般是为了:增加可读性、程序的可理解性，从而提高程序的可维护性以及程序代码质量教材:雍俊海.《Java程序设计》.北京:清华大学出版社,2008.2020/2/169命名规范•良好的命名规范可以增强程序的可读性•可以给标识符提供功能/属性上的一些额外信息—例如:是否是常量、类、包等。这些信息对理解程序非常有帮助教材:雍俊海.《Java程序设计》.北京:清华大学出版社,2008.2020/2/1610问题?•命名规范应当包含哪些内容?教材:雍俊海.《Java程序设计》.北京:清华大学出版社,2008.2020/2/1611命名规范内容•包•文件•类/接口•方法•变量•常量教材:雍俊海.《Java程序设计》.北京:清华大学出版社,2008.2020/2/1612包的命名规范•包的名称一般全部采用小写•包名的前缀一般是域名单词序列的逆序•示例com.sun.engcom.apple.quicktimeedu.cmu.cs.bovik.cheese教材:雍俊海.《Java程序设计》.北京:清华大学出版社,2008.2020/2/1613文件的命名规范•Java源程序文件的命名规范–必须与该文件中public类的类名同名–后缀必须是.java教材:雍俊海.《Java程序设计》.北京:清华大学出版社,2008.2020/2/1614类/接口的命名规范1)类名一般是名词/名词词组:每个单词的首字母大写，其它字母小写2)类名应当尽量简单，而且其含义能够尽量准确地刻画该类的含义3)一般采用全称—尽量少用缩写词(除非该缩写词被广泛使用)•示例J_ClockJ_CircleTimeImageSprite(图版精灵)教材:雍俊海.《Java程序设计》.北京:清华大学出版社,2008.2020/2/1615方法的命名规范•方法名一般是/–动词/动词性词组,–首字母小写–中间单词的首字母大写，其它字母小写•示例:run();getBackground();getTime();教材:雍俊海.《Java程序设计》.北京:清华大学出版社,2008.2020/2/1616尽量应用常用词•尽量应用简单的、常用的单词•示例:get/setfirst/lastadd/removeup/downcreate/destroymin/maxstart/stopnext/previousinsert/deleteold/newincrement/decrementopen/closeold/newshow/hidebegin/end教材:雍俊海.《Java程序设计》.北京:清华大学出版社,2008.2020/2/1617变量的命名规范•变量名的首字母小写•中间单词的首字母大写，其它字母小写•变量名的首字母尽量不要用字符:_或$•变量名应当简短、有含义、且便于记忆•示例:inti;charc;doublewidthBox;教材:雍俊海.《Java程序设计》.北京:清华大学出版社,2008.2020/2/1618变量的命名规范•变量名常常由表示其所扮演的角色与数据类型组成•示例:PointstartingPoint,centerPoint;NameloginName;教材:雍俊海.《Java程序设计》.北京:清华大学出版社,2008.2020/2/1619常量的命名规范•常量名一般全大写，单词之间用下划线分隔(“_”)•示例:staticfinalintMIN_WIDTH=4;staticfinalintMAX_WIDTH=999;教材:雍俊海.《Java程序设计》.北京:清华大学出版社,2008.2020/2/1620编辑方法•特殊字符•行数/每行的字符数•缩排方式(Indentation)•空白符/行教材:雍俊海.《Java程序设计》.北京:清华大学出版社,2008.2020/2/1621语句书写——关键•保证代码的简单性教材:雍俊海.《Java程序设计》.北京:清华大学出版社,2008.2020/2/1622文件组织•源程序文件一般采用如下的组织顺序:–最开始一般是注释–package和import语句–类和接口的定义教材:雍俊海.《Java程序设计》.北京:清华大学出版社,2008.2020/2/1623本章总体纲要•编程规范•文档注释教材:雍俊海.《Java程序设计》.北京:清华大学出版社,2008.2020/2/1624javadoc•Javadoc是一种从文档注释生成HTML帮助文件的工具–文档注释介于/**和*/之间•示例/**SortsintegerarrayusingemMySort/emalgorithm*/教材:雍俊海.《Java程序设计》.北京:清华大学出版社,2008.2020/2/1625文档注释的一般格式•示例:/***Thisisthedescriptionpartofadoccomment**@tagCommentforthetag*/教材:雍俊海.《Java程序设计》.北京:清华大学出版社,2008.2020/2/1626常用的javadoc文档标签@author@param@return@see@throws@deprecated@link@since@version教材:雍俊海.《Java程序设计》.北京:清华大学出版社,2008.2020/2/1627运行javadoc•在命令行下执行:javadocoptionspackagessources–options:选项列表–packages:包列表–sources:源文件列表•示例:javadoc-d.-authorTime3.java教材:雍俊海.《Java程序设计》.北京:清华大学出版社,2008.2020/2/1628作业习题10.7教材:雍俊海.《Java程序设计》.北京:清华大学出版社,2008.2020/2/1629本课件使用要求•使用本课件，必须注明引用(具体见下一个幻灯片)•书及课件均可能出现一些错误和缺陷，恳切希望广大读者特别是讲授此课程的老师批评指正教材:雍俊海.《Java程序设计》.北京:清华大学出版社,2008.2020/2/1630引用声明•本课件来源于(或参考了)下面的书及其课件:–雍俊海.《Java程序设计》.北京:清华大学出版社,2008.教材:雍俊海.《Java程序设计》.北京:清华大学出版社,2008.2020/2/1631免责声明•请合法使用课件，其用途应当合法有益而且不应对任何人造成任何伤害或损失•同时请注意教材作者及出版社没有对本课件做出任何承诺与保证教材:雍俊海.《Java程序设计》.北京:清华大学出版社,2008.2020/2/1632参考文献•本课件的参考文献与下列书的参考文献相同–雍俊海.Java程序设计.北京:清华大学出版社,2008.–雍俊海.Java程序设计教程（第2版）.北京:清华大学出版社,2007.–雍俊海.Java程序设计习题集(含参考答案).北京:清华大学出版社,2006.–雍俊海.Java程序设计.北京:清华大学出版社,2004.教材:雍俊海.《Java程序设计》.北京:清华大学出版社,2008.2020/2/1633谢谢•请多指教