一.java的三种注释类型 单行注释:// ...... 块注释:/* ...... */ 文档注释:/** ...... */ 二.指导原则 注释不能美化糟糕的代码,碰到糟糕的代码就重新写吧. 用代码来阐述你的意图,好的代码就是最好的注释. 错误的注释比不注释更可怕. 大括号后不要加注释,建议另起一行. 注释调的代码建议删掉. 废话式注释,循规式注释,误导性注释都应该删掉. 巧用标记(TODO.FIXME) 注释要放在距离其描述代码最近的位置. 三.代码格式列举 这里和大家聊下代码基本格式,好…

<阿里巴巴Java开发手册>代码格式部分应用--idea中checkstyle的使用教程 1.<阿里巴巴Java开发手册> 这是阿里巴巴工程师送给各位软件工程师的宝典,就像开车需要交规一样,我们编程也需要规范,这本手册就从编程规约.异常日志.MySQL数据库.工程结构.安全规约等五个方面给出了规范,给出时又分成了强制.推荐.参考三种类型以供参考.下面有手册目录截图以及下载二维码. 2.checkstyle在idea中的使用 简介:checkstyle是idea中的一个插件可以很方便…

规范需要平时编码过程中注意,是一个慢慢养成的好习惯 1.基本规则 1.注释应该使代码更加清晰易懂   2.注释要简单明了,只要提供能够明确理解程序所必要的信息就可以了.如果注释太复杂说明程序需要修改调整,使设计更加合理.   3.注释不仅描述程序做了什么, 还要描述为什么要这样做,以及约束   4.对于一般的getter.setter方法不用注释   5.注释不能嵌套   6.生成开发文档的需要用中文编写 2.三种注释方式说明 1.文档注释 /** */ 可以对用多行,一般用来对类.接口.成员方…

在写代码时常常有2种代码样式习惯,如下图.由于一直习惯了第一种代码格式,而看第二种代码格式时感觉代码很乱,总找不到“{ }”对称的感觉.Eclipse自动格式化代码的快捷方式是Ctrl+Shift+F ,其默认是第二种样式,下面将通过设置eclipse来达到第一种代码样式. 启动eclipse →window→ preferences → Java→ Code Style → Formatter ,如图 可以选择New新建一个样式然后Edit进行编辑,主要是做如下修改,即把类和方法在声明时进行换…

列举两种不同类型的Java标识注释,并解释它们之间的区别.…

在项目开发维护中,编码规范作为开发规范的一个组成部分,是十分重要和必须的,它不仅仅是为了提高开发效率,也有利于降低后期维护开发的成本.编码规范的根本目的就是要让不仅代码可以一目了然,也可以很容易的理解开发人员所编写的代码程的用途和意义.由此,用来减少项目中因为开发维护人员的更替或由于长时间不维护造成的记忆模糊或混乱等情况带来的对代码所实现的真正功能的理解困难和歧义.另外也提高了代码复查效率和效果. 第一章Eclipse配置 1.1 codeformat和codetemplates导入 模板导入操…

在JAVA中支持单行注释和多行注释 1.单行注释,只要在注释的一行代码中加上双斜杠即可 例如: // int a=2,b=4,c=8; 2.多行注释,在开始位置加上/* 结束位置加上*/ 例如 /* int a =3; if (a%2==0) { System.out.println(a+" 是偶数"); System.out.println(a+" 不是奇数"); }else { System.out.println(a+" 是奇数"); Sy…

东汉大臣陈蕃有一则这种故事,"一屋不扫何以扫天下",寓意来表明一个大丈夫,假设连自己的居室都不能打扫干净,怎么胸怀天下.<代码整洁之道>就是来劝诫我们程序猿写出更优秀的代码,而"格式"一章也恰巧给我们举出了非常多原则,以供我们写出更加规整的代码. 格式的目的 好的代码格式,让人赏心悦目,而且随着版本号的更迭.让你可以随心所欲的进行变更.而不是每次都痛苦不堪. 垂直格式 类文件的行不应该成千上万行,应尽量保持短小.当然这点非常难做到,我们习惯于在一个类中完…

流水淡,碧天长,鸿雁成行.编码风格,简捷清爽,反引无限风光. 在美剧<硅谷>中有这样一个经典镜头,主人公 Richard 与同为开发工程师的女友闹分手,理由是两人对缩进方式有着截然不同的编程习惯,互相鄙视对方的代码风格.Richard 认为＂ one tab saves four spaces ",…

注释是一种形式的元数据,提供了非程序自身的数据,注释对于被注释的代码没有直接的影响. 本文主要概括注释的使用,java平台(SE)预定义的注释,类型注释是如跟可插入类型系统连用达到更强的类型检查的,以及如何实现重复注释. 注释有许多用途,包括: 为编译器提供信息--编译器可以利用注释检查错误或者抑制警告信息 编译时或者部署时处理--软件工具可以处理注释并生成代码,XML文件等等 运行时处理--有些注释在运行时可以被检测到 注释格式 注释最简单的形式如下: @Entity @符号提示编译器接下来的…