java注释规范（共5篇）
java注释规范 篇1
JAVA代码注释规范
一、规范存在的意义
1.好的注释规范可以让人一眼看明白这是干什么的，特别是对于我们这种行业；共同合作完成一个项目需要分工明确，所以也需要有明了的注释规范。
2.正确的应用注释规范可以增加代码的可读性、理解性。3.好的代码规范可以提高团队的开发效率，从而节省时间。4.长期的坚持代码规范可以让程序员养成一个良好的习惯，甚至锻炼出思维。
二、命名规范
1.一般概念
1)尽量使用完整的英文描述。2)采用相对好理解的术语。
3)采用骆驼命名的规范使名字增加可读性。4)尽量少用缩写提高可读性。5)避免名字过长。
6)避免使用类似的名字。7)避免使用特殊符号。2.主要的运用
1)类（class）的命名
2)接口(interface)的命名 +方法(method)的命名 3)参数(param)的命名
三、注释规范
1.一般概念
1)注释应该增加代码的清晰度 2)保持代码的整洁
3)在写代码之前或同时注意写上注释
4)注释出为什么做这件事，做这件事的结果 2.注释那些部分
1)java文件：版权信息、创建时间、创建人 2)类：目的、所完成功能、版权信息、创建人 3)方法：参数含义、返回值 4)属性：字段描述
5)接口：目的、创建人、版本号、创建时间
四、代码格式规范
1.单行注释://注释内容，一般与代码后空4-8格，注释必须对齐 2.块状注释：/*注释内容*/，一般是注释从以/*开始，以*/结束中的所有内容。3.文档注释：/**......*/所以注释文 档必须书写在类、域、构造函数、方法，以及字段(field)定义之前.注释文档由两部分组成——描述、块标记。4.javadoc注释标签
@author 对类的说明 标明开发该类模块的作者
@version 对类的说明 标明该类模块的版本
@see 对类、属性、方法的说明 参考转向，也就是相关主题
@param 对方法的说明 对方法中某参数的说明
@return 对方法的说明 对方法返回值的说明
@exception 对方法的说明 对方法可能抛出的异常进行说明
五、java注释具体实现
1.源文件注释
/** *文件名 *创建人 *创建时间 *修改人 *描述 *版本号 */ 2.类注释
/** *对此类的描述信息 *创建人 *版本号 *创建时间 */ 3.方法的注释
/** *方法的用处 *该方法的参数列 *该方法返回的值 */ 4.属性的注释
/** *字段的描述 */ 5.接口注释
/** *对此接口的描述 *创建人 *创建时间 *版本号 */ 6.构造方法注释
/** *描述该构造方法的用处 *该构造方法的参数列 *参数的类型 */
六、Jsp代码格式规范
1.多行注释:,一般是注释从以结束中的所有内容。
2.文本注释:<%--内容--%>,主要是对该页面的一些描述，目的、创建人、创建时间、版本号、文件名、备注、修改人等.例如: <%---创建人-创建时间-版本号-文件名-备注-修改人--%> 3.伪劣标签注释:<% java语句块 %> 例如： <% JAVA代码块 %> 4.单行注释：//注释内容，一般与代码后空4-8格，注释必须对齐
七、JS代码格式规范
1.文本注释:/** 注释内容 **/，主要是对该页面的一些描述，目的、创建人、创建时间、版本号、文件名、备注、修改人等.也可以用于注释代码块。例如: /** *创建人 *创建时间 *版本号 *文件名 *备注 *修改人 **/
2.文本注释:/** 内容 */ ,主要是对该页面的一些描述，目的、创建人、创建时间、版本号、文件名、备注、修改人等.也可以用于注释代码块。例如: /** *创建人 *创建时间 *版本号 *文件名 *备注 *修改人 */ 3.单行注释: //注释内容，一般与代码后空4-8格，注释必须对齐 4.多行注释: /* 注释内容 */,一般是注释从以/* 开始，以*/结束中的所有内容。
八、JS注释具体实现 1.文件注释
/** *对此文件的描述信息 *创建人 *版本号 *创建时间 */ 2.方法的注释
/** *方法的用处 *该方法的参数列 *该方法返回的值 */ 3.模块的注释
/** *模块名称
*模块的用处
*/
java注释规范 篇2
例如,人教社初中语文课本古文注释中,无论古今字、通假字、异体字,一般都注作“X同X”,《愚公移山》一文“始以反焉”中的“反”和“返”本是一组古今字,教材注为“反同返”;“河曲智叟亡以应”中的“亡”和“无”本属通假字,教材注为“亡同无”,《鸿门宴》中“沛公不胜桮杓”一句中的“桮”本是“杯”的异体字,教材中同样注为“桮同杯”。
再如高中教材,除了“X同X””的注释外,更多的则是使用“X通X”。“只用这两种形式给通假字、古今字和异体字三种用字情况注释,并常有混用现象,势必造成学生对用字问题的不理解。”[2]如《登泰山记》中“须臾成五采”的“采”与“彩”本属一组古今字,教材第二册注为“采同彩”。《石钟山记》中“至莫夜月明”的“莫”与“暮”本也属古今字,教材却注为“莫通暮”。
朱振家主编的由高等教育出版社出版的《古代汉语》中对文言文的注释相对要好得多,使读者从它的注释用语中一般都能区分出被注字和注字之间是古今字还是通假字,但对异体字却没有注明,个别注释用语也指向不明,难以把握其主要职能。
疏理有关文言文作品的教科书(以朱振家《古代汉语》注释为主,以下简称朱注),其中对通假字、古今字、异体字的注释用语大致有以下几种模式:
A.X,X的古字
B.X后来写作X
C.X通X
D.X与X义通
E.X同X
F.X义同X
G.X与X同义
为了方便分析,我们将以上七种注释用语根据其用字特点分为三类:AB为一类,我们暂称其为“古”字注;CD为一类,暂名为“通”字注;EFG为一类,暂名为“同”字注。下面进行具体分析。
关于“古”字注
“古”字注是用来说明被注字和注字之间的关系是古今字的注释用语,因其作注时常用一“古”字,所以称之为“古”字注。什么是古今字呢?古今字就是从一个多义词(一字写多词)中剥离出某一个或几个义项,交给另一个或几个新造的字来表示的用字现象。“我们把分化前一字写多词时期的字称为古字,而把分化出来的记词各有专司的字称为今字。”[3]上文A注“X,X的古字”即属于此。古今字着眼于造字的先后顺序,古和今的概念是相对的,即在一组古今字中,古字产生的早,今字产生的晚。今字的产生又分两种情况,一种是为分化出来的义项另造新字,如“说,悦的古字”(朱注);就是把“说”这个词表示的“高兴”的义项交给新造的“悦”字,而“说”本身就再不表示喜悦的意思;另一种是由分化出来的意义占据本形,而为本义另造新字,如上“莫,暮的古字”(朱注),就是把“莫”这个词本有的“晚”的意思由新造的“暮”字来表示,而“莫”的本形则另司新职,表示“没有谁”、“没有哪一个”、或“不”等虚化的意思。这种注释表述简便明确,而且也用得较多。
上文B式“X后来写作X”,在朱振家的《古代汉语》中反映的是一种特殊的用字现象,即今字产生后,古字被废弃不用了。如该书为《大同》“在埶者去”作注道:“埶,势力、权势。后来写作势”。即是说“势”字产生以后,“埶”字就成了一个死字。因为被注字和作注字产生早晚不同,与A式所注情况相似,而且这种情况又很少,为了便于认识,在此我们也将它归为古字注一类。其实,笔者以为,本着避繁就简的原则,忽略被注字是否已被废弃不计,B式完全可以用A式来替代,如注为“埶,势的古字”。
关于“通”字注
“通”字注是表示被注字和注字之间为通假关系的注释用语。因其注释时常用一“通”字,所以称为“通”字注。上文所列C式“X通X”和D式“X与X义通”即是。
何谓通假?简言之,通假就是指文言文中本有其字的同音或音近替代字,是古人用字的临时替代现象。王力先生说:“通假说穿了就是古人写别字。”[4]
例1:《鸿门宴》:“旦日不可不蚤来谢项王”。许多注本都注作“蚤通早”。即是说“早”是本字,“蚤”是临时用来替代的通假字。
例2:《触龙说赵太后》“没死以闻”,朱注“没,通冒”。
例3:《北冥有鱼》的“冥”,朱注“冥,与溟义通”。《辞海》释为“冥,通溟”。这是否可以说明D式“X与X义通”属于通假字的注释用语呢?如果是,那么,我们在阅读原文时,只需按通假字的原则根据本字“溟”的读音和意思理解就行,而临时通假的“冥”与“溟”意义上到底有什么关系,则与理解文意并无妨碍。
归结以上三例,笔者以为“X通X”、“X与X义通”均为通假字的注释用语,并且都可以用C式“X通X”来表示。只不过要说明的是这一注释用语包含了两种情况,一种是用来通假的字与本字读音相同或相近,词义上毫无关系,另一种是用来通假的字与本字除读音相同或相近之外,意义上也有相同之处。
关于“同”字注
“同”字注是指注释用语中常含一“同”字的注释现象。通过上文分析得知,“古”字注对应着古今字,“通”字注对应着通假字,那么,“同”字注对应着什么呢?笔者以为,“同”字注的情况比较复杂。首先它有“X同X”、“X义同X”、“X与X义同”等几种不同的模式;其次它所表明的被注字和注字之间的关系复杂多样。下面试作以具体分析。
1.“X同X”是“同”字注的基本模式,常用来说明被注字和注字之间属异体字关系
什么是异体字呢?“异体字又称或体字,是指共同写一个词的不同的书写形式。换言之,就是所记的词音、义完全相同而形体不同的字。这些字在任何情况下都可以互换,而词义不发生歧误。”[5]试举二例:
例1:《齐晋鞌之战》“癸酉,师陈于鞌。”朱注:“鞌,同鞍,齐地名。”
例2:《冯谖客孟尝君》“券徧合,起,矫命,以责赐诸民。”朱注:“徧,同遍。”
以上二例中被注字和注字“鞌”与“鞍”、“徧”与“遍”均属异体字。原因一,《辞海》中释道:“鞌,鞍的异体字”;“徧,遍的异体字”。原因二,它们均符合异体字的构成原理,即鞌与鞍读音相同,构字部件相同,只是部件的位置发生了变化,属于典型的异体字;徧与遍都是形声字,它们有着共同的声符“扁”,而形符“彳”(zhí)与“辵”(chuò)都与走有关系。《说文》:“彳,小步也”;“辵,乍行乍止也。”可见,它们也是典型的异体字。
笔者以为,给以上这类被注字和注字之间明显属于异体关系的字作注时,最好不用“同”字注,而应当注作“鞌,鞍的异体字。”“徧,遍的异体字。”——我们也可以暂称之为“异字注”。
2.“同”字注用来说明被注字和注字之间是同义互释关系
例1:《许行》:“兽蹄鸟迹之道,交于中国。”朱注:“迹,与蹄同义。”
例2:《许行》:“后稷教民稼穑,树艺五谷。”朱注:“树,义同艺,种植。”
例3:《许行》:“辅之翼之,使自得之。”朱注:“翼,用作动词,义同辅。”
以上三例的注释中,虽都用了一个“同”字,但“迹”与“蹄”、“树”与“艺”、“翼”与“辅”均不是异体字,而是同义词互释。
3.“同”字注用来说明被注字和注字之间属于通假字关系
例1:《郑伯克段于鄢》:“遂寘姜氏于城颖。”朱注:“寘,同置。放置,安置。”
例2:《齐姜劝文公勿怀安》:“其闻之者,吾以除之矣。”朱注:“以,同已。已经。”
第1例朱振家《古代汉语》讲道:“要鉴别貌似异体而实非异体的字,如寘置。因为‘置’与‘寘’除安放之义外,余皆不同。”[6]可见,教材编者在这里有意识地用这个“同”字注,表明两字的关系并非异体字。第2例《辞海》“以”下第13条注:“通‘已’”。《古汉语常用字字典》注:“通‘已’。已经。”如果这里的“通”当通假讲,那么“同”字注则有表明被注字和注字之间是通假关系的用法。
4.“同”字注表明被注字和注字之间的关系还有待进一步考证
《齐晋鞌之战》:“左并辔,右援枹而鼓。”朱注:“枹,同桴。鼓槌。”《辞海》:“同桴,鼓槌。”“枹”、“桴”二字到底是古今字、通假字、还是异体字?上注均未说明。《说文》:“桴,栋名。从木孚声。”“枹,击鼓杖也。从木包声。”段玉裁注:“桴,本训栋。借为鼓柄字耳。”又注“枹桴二字同体。”段注是否正确,不敢妄断。上注均未采用,是否可以说明这二字之间的关系还有待进一步考证。
5.“同”字注有时也表明被注字和注字之间的关系在认识上还存在分歧
《郑伯克段于鄢》:“请京,使居之,谓之京城大叔。”朱注:“大同太。”(没有明示关系)《辞海》:“大(tài)通太。”(似乎认为是通假关系)《古汉语常用字字典》:“大(tài),这个意义后来写作太。”(认为二字为古今字)“大、太”二字究竟是通假字,还是古今字?在没有可靠的证据证明之前,似乎只有使用“同”字注最为稳妥。
由以上分析可知,“同”字注是一种比较含混而高明的注释法。它在现今的各种文言注本中,有时表异体关系,有时表通假关系,有时表古今关系,如遇对二字的关系认识不统一或有待进一步考证时,“同”字注更是大有其用武之地。
总结:“古”字注、“通”字注、“同”字注,是文言文注本中主要用来说明被注字和注字之间,属于古今字、通假字、还是异体字的注释用语。其中,“古”字注是用来说明古今字的,“通”字注是用来说明通假字的,“同”字注的情况比较复杂,要根据情况具体分析。
“同”字注的解说比较笼统,其目的主要在于让读者了解二字的相关性及其在文中的意义,所以初中教材中一般都采用这种注释法。“通”字注和“古”字注,除了帮助读者了解词义外,还指出了二字之间的相互关系是临时借用呢,还是未分化之前的古字,它要求读者对汉字的认识更深了一层。对大学课程来说,“同”字注则还提示着可以由此进一步探求二字之间的关系。“同”字注是一个有待进一步探讨的领域。笔者认为,“同”字注中已经能判明被注字和注字是古今字、或是通假字、或是异体字的,在作注时,不妨采用相应的“古”字注或“通”字注,确定是异体字的,则应注明为异体字,(可称为“异”字注),而只把同义互释、或认识上有分歧的、或其关系有待进一步考证的字的注释交给“同”字注。这样,“同”字注的负担就不会太重,使用也不至太滥,文言文注释用语也就比较规范了。如能做到这点,那将是教师和学生莫大的幸事了。
参考文献
[1]林玉芬.高中《语文》第一册文言文注释考析[J].成功教育,2008,3.
[2]同上.
[3]朱振家.古代汉语[M].北京:高等教育出版社,1994.
[4]王力.古代汉语[M].北京:中华书局,1981.
[5]朱振家.古代汉语[M].北京:高等教育出版社,1994.
引文注释规范 篇3
(一)来自图书的引文
(1)著作
顺序：责任者?著作名?出版者?出版年?页码
资中筠：《国际政治理论探索在中国》，上海人民出版社，1998年，第304页。
[美]罗伯特?基欧汉：《霸权之后》，上海人民出版社，2001年，第109-119页。
Charles Kupchan, The End of the American Era: U.S. Foreign Policy and the Geopolitics of the Twenty-first Century, New York: Knopf, 2002, p. 28.
(2)析出文献（著者和析出篇名可视具体需要标注或不标注）
顺序：著者?析出篇名?文集编者?文集题名?出版者?出版年?页码
亚历山大?文特：“国际政治中认同和结构变化”，约瑟夫?拉彼德、弗里德里希?克拉托赫维尔主编：《文化与认同：国际关系回归理论》，浙江人民出版社，2003年，第75页。
《毛泽东外交文选》，中央文献出版社、世界知识出版社，1994年，第93页。
《马克思恩格斯书信集》，人民出版社，1962年，第7-8页。
Noam Chomsky, “International Terrorism: Image and Reality,” in Alexander George （ed.）, Western State Terrorism, New York: Routedge, Champman & Hall, Inc., 1991, p. 28.
(二)来自期刊和报纸的引文
顺序：著者?篇名?期刊名（报纸名）?年期（年月日）?页码（可省略）
秦亚青：“多边主义研究：理论与方法”，《世界经济与政治》，2001年第10期，第9页，第13页。
门洪华：“国际机制与美国霸权”，《美国研究》，2001年第1期，第74-88页。
中国外交部亚洲司司长傅莹：“新时期的亚洲”，《大公报》，2003年3月12日。
参考文献及注释规范 篇4
（1）“注释”指作者进一步解释自己所要表达的意思，注释安排在当页页脚，用带圈数字表示序号，如注①、注②等，注释的序号与文中序号一一对应。
（2）“参考文献”指作者引文所注的出处，一律放在论文尾末，文中设序号 [1]，参考文献的序号与文中序号一一对应。页码置于文中序号之后，例： [1]（P12）。
（3）“参考文献”也指虽未直接引述别人的话、但参考了别人著作和论文的意思，应在段中或段末设序号 [1]，并在文末注明。本项与第2项不必分列，交叉排序即可。文末的序号与文中序号一一对应。此种情况可以不注明页码。
（4）同一参考文献多次被引用，文末只标一个序号，文中应多次出现同一序号，在文中序号后加圆括号，注明所引文献的不同页码或篇名。
（5）参考文献与注释的区别。参考文献是作者写作论著时所参考的文献书目，集中列于文末；注释则是作者对论著正文中某一特定内容的进一步解释或补充说明，列于该页地脚（以脚注形式标出）。参考文献序号用方括号标注，注释序号则用数字加圆圈标注，位于标点符号之后；若是直接引文，则位于后引号之后。
二、中文参考文献及注释规范
（一）、文后参考文献及其随文夹注格式
参考文献按在正文中出现的先后次序列于文末，以“参考文献：”（左顶格）作为标识。参考文献的序号左顶格，并用数字加方括号表示，如[1]，[2]，…；每一条参考文献条目的最后均以小圆点“.”结束。
引文的起止页码以随文以夹注的形式、用6号宋体标出，其格式为：[序号]（p×）。各类参考文献及其在正文中夹注的格式及示例如下：
1、专著、论文集、学位论文、报告
[序号]主要责任者.文献题名[文献类型标识].出版地：出版者，出版年.[1] 列维·布留尔.原始思维[M].北京：商务印书馆，1987.[2] 马克思.恩格斯.共产党宣言[A].马克思恩格斯选集[M].第一卷.北京：人民出版社，1972.[3] 洪亮吉.春秋左传诂[M].卷三.[4] 人事部一·叙人[A].太平御览[M].北京：中华书局，1960.[5] 皇甫湜.皇甫持正文集[M].卷四.四部丛刊本.[6] 房玄龄等.晋书·司马彪传[M].北京：中华书局，1974.[7] Chester.The Rise of British Industrial Society[M].Longman, 1982.以例[6]、[7]为例，其随文夹注格式分别为： [6]（p.4142.）、[7]（p.289.）。
多次引用同一本书中的材料，随文夹注中一律采用第一次出现的序号。例如：第一次引用[7]中材料时，夹注为“[7]（p289）”；第二次引用[7]中材料时，夹注为“[7]（p163）”。多种材料说明一个问题，在随文夹注中则按次序列出，例：“[4]（p×）；[5]（p×）”。
2、期刊文章
[序号]主要责任者.文献题名[J].刊名，年，卷（期）.例：
[8] 李醒民.哲学不是敲门砖和摇钱树[J].学术界，2000，（1）.随文夹注格式： [8]（p206）。
3、论文集中的析出文献
[序号]析出文献主要责任者.析出文献题名[A].原文献主要责任者（任选）.原文献题名[C].出版地：出版者，出版年.例：
[9] 王旭.美国三大城市与美国现代区域经济结构[A].中国美国史研究学会.美国现代化历史经验[C].北京：东方出版社，1994.随文夹注格式：[9]（p183）。
4、报纸文章
[序号]主要责任者.文献题名[N].报纸名，出版日期（版次）.例：
[10]杨玉圣.把书评当作学问来做[N].中华读书报，1996-10-09（2）.5、电子文献
[序号]主要责任者.电子文献题名[电子文献及载体类型标识].电子文献的出处或可获得地址，发表或更新日期/引用日期.例：
[11]王明亮.关于中国学术期刊标准化数据库系统工程的进展[EB/CD].http://,1998-08-16/1998-10-04.报纸文章和电子文献在随文夹注中直接以序号标出，而省略“（p×）”著录项。
6、各种未定义类型的文献 [序号]主要责任者.文献题名[Z].出版地：出版者，出版年.例：
[12]何晓明.降落民间——21世纪中国历史学走向管窥（第十一届全国史学理论研讨会论文）[Z].武汉：湖北大学中国文化研究院，2000.三、英文参考文献及注释规范
英文参考文献Bibliography（Bibliography使用“Times New Roman”字体，小四号，加粗，后面不加任何标点符号。）
1.专著：
1)基本格式（请严格注意标点符号）：作者的姓名（英文作者的姓，名）.年份.书名（斜体）.出版地:出版商.如果同一作者两本以上同年出版的参考书，在年份后用a，b，c 等标出； 如有第二行，则须缩进4个英文字符。例：
Chomsky, N.1981a.Lectures on government and binding.Dordrecht: Foris.Chomsky, N.1981b.Theory of markedness in generative grammar.Pisa, Italy: Scuola Normale Superiore.2)书的主编（格式：各项信息的排列顺序基本同上，在主编姓名后加ed.）：
例：Hall, David, ed.1981.The Oxford book of American literary anecdotes.New York: OUP.3)机构作者（格式：各项信息的排列顺序基本同上）：
例：American library association.1983.Intellectual freedom manual.2nd ed.Chicago: ALA.4)翻译著作（格式：各项信息的排列顺序基本同上，加xx Trans.）：
例：Calvino, Ian.1986.The uses of literature.P.Creagh Trans.San Diego: Harcourt.2.文章：
1)期刊文章基本格式（请严格注意标点符号）：作者姓名.年份.篇名.刊名（要斜体）.刊物的卷号和期号:文章的起止页码.例：
Boling, D.1965.The atomization of meaning.Language 41:555-573.2)论文集中的文章基本格式（请严格注意标点符号）：作者姓名.年份.篇名.论文集作者姓名.eds.论文集名称（要斜体）.出版地:出版商.文章的起止页码.例：
Peters, M & T.B.Stephen.1986.Interaction routines as cultural influences upon language acquisition.In Schieffelin, B.B.& E.Ochs, eds.Language Socialization Across Cultures.Cambridge: CUP, 80-96.附1：参考文献类型及其标识
参考文献 专著 论文集 析出文献 报纸文章 期刊文章 学位论文 报告
文献类型标识 M C A N J D R 无法根据上述分类的文献，其标识码一律用“Z”表示。
附2：电子文献的载体类型及其标识（[文献类型标识/载体类型标识]）
电子文献载体类型：磁带（magnetic tape）——MT；磁盘（disk）——DK；光盘（CD-ROM）——CD；联机网络（online）——OL。按下列格式表示包括了文献载体类型的参考文献类型标识：
[DB/OL]——联机网上数据库（database online）
[DB/MT]——磁带数据库（database on magnetic tape）
[M/CD]——光盘图书（monograph on CD-ROM）
[CP/DK]——磁盘软件（computer program on disk）
[J/OL]——网上期刊（serial online）
Java命名规范 篇5
（一）Package(包)的命名:
Package的名字应该都是由一个小写单词组成,例如net.ebseries.modules。
（二）Class(类)的命名:
Class的名字首字母大写,通常由多个单词合成一个类名，要求每个单词的首字母也要大写,例如：DataFile或InfoParser。
（三）变量的命名:
变量的名字可大小写混用，但首字符应小写。词由大写字母分隔，限制用下划线，限制使用美元符（$），因为这个字符对内部类有特殊的含义。如：inputFileSize。
（四）Interface(接口)的命名:与Class的命名类似。
（五）Static Final 变量（相当于常量）的命名
Static Final 变量的名字应该都大写，并且指出完整含义，例如：final MAXUPLOADFILESIZE=1024。
（六）方法的命名
方法名的第一个单词应该是动词，大小写可混用，但首字母应小写。在每个方法名内，大写字母将词分隔并限制使用下划线。参数的名字必须和变量的命名规范一致。使用有意义的参数命名，如果可能的话，使用和要赋值的字段一样的名字：
setCounter(int size){this.size = size;}
数组的命名
数组应该总是用下面的方式来命名：byte[] buffer;而不是：byte buffer[](习惯性问题而已)。
值得注意的是，命名时应尽量采用完整的英文描述符（也有特例）。此外，一般应采用小写字母，但类名、接口名以及任何非初始单词的第一个字母要大写。