java工作中良好的代码注释习惯是什么

注释是为了方便自己或代码维护方更容易地读懂代码的用处。

创新互联是一家专注于成都网站设计、网站制作、外贸营销网站建设与策划设计,曲阜网站建设哪家好?创新互联做网站,专注于网站建设10年,网设计领域的专业建站公司;建站业务涵盖:曲阜等地区。曲阜做网站价格咨询:13518219792

一、背景 

1、当我们第一次接触某段代码，但又被要求在极短的时间内有效地分析这段代码，我们需要什么样的注释信息？ 

2、怎么样避免我们的注释冗长而且凌乱不堪呢？ 

3、在多人协同开发、维护的今天，我们需要怎么样的注释来保证高质、高交的进行开发和维护工作呢？ 

二、意义 

程序中的注释是程序设计者与程序阅读者之间通信的重要手段。应用注释规范对于软件本身和软件开发人员而言尤为重要。并且在流行的敏捷开发思想中已经提出了将注释转为代码的概念。好的注释规范可以尽可能的减少一个软件的维护成本 , 并且几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护。好的注释规范可以改善软件的可读性，可以让开发人员尽快而彻底地理解新的代码。好的注释规范可以最大限度的提高团队开发的合作效率。长期的规范性编码还可以让开发人员养成良好的编码习惯，甚至锻炼出更加严谨的思维能力。 

三、注释的原则 

1、 注释形式统一 

在整个应用程序中，使用具有一致的标点和结构的样式来构造注释。如果在其他项目组发现他们的注释规范与这份文档不同，按照他们的规范写代码，不要试图在既成的规范系统中引入新的规范。 

2、 注释的简洁 

内容要简单、明了、含义准确，防止注释的多义性，错误的注释不但无益反而有害。 

3、 注释的一致性 

在写代码之前或者边写代码边写注释，因为以后很可能没有时间来这样做。另外，如果有机会复查已编写的代码，在今天看来很明显的东西六周以后或许就不明显了。通常描述性注释先于代码创建，解释性注释在开发过程中创建，提示性注释在代码完成之后创建。修改代码的同时修改相应的注释，以保证代码与注释的同步。 

4、 注释的位置 

保证注释与其描述的代码相邻，即注释的就近原则。对代码的注释应放在其上方相邻或右方的位置，不可放在下方。避免在代码行的末尾添加注释；行尾注释使代码更难阅读。不过在批注变量声明时，行尾注释是合适的；在这种情况下，将所有行尾注释要对齐。 

5、 注释的数量 

注释必不可少，但也不应过多，在实际的代码规范中，要求注释占程序代码的比例达到20%左右。注释是对代码的“提示”，而不是文档，程序中的注释不可喧宾夺主，注释太多了会让人眼花缭乱，注释的花样要少。不要被动的为写注释而写注释。 

6、删除无用注释 

在代码交付或部署发布之前，必须删掉临时的或无关的注释，以避免在日后的维护工作中产生混乱。 

7、 复杂的注释 

如果需要用注释来解释复杂的代码，请检查此代码以确定是否应该重写它。尽一切可能不注释难以理解的代码，而应该重写它。尽管一般不应该为了使代码更简单便于使用而牺牲性能，但必须保持性能和可维护性之间的平衡。 

8、 多余的注释 

描述程序功能和程序各组成部分相互关系的高级注释是最有用的，而逐行解释程序如何工作的低级注释则不利于读、写和修改，是不必要的，也是难以维护的。避免每行代码都使用注释。如果代码本来就是清楚、一目了然的则不加注释，避免多余的或不适当的注释出现。 

9、必加的注释 

典型算法必须有注释。在代码不明晰或不可移植处必须有注释。在代码修改处加上修改标识的注释。在循环和逻辑分支组成的代码中添加注释。为了防止问题反复出现，对错误修复和解决方法的代码使用注释，尤其是在团队环境中。 

10、注释在编译代码时会被忽略，不编译到最后的可执行文件中，所以注释不 

会增加可执行文件的大小。 

四、JAVA注释技巧 

1、空行和空白字符也是一种特殊注释。利用缩进和空行，使代码与注释容易区 

别，并协调美观。 

2、当代码比较长，特别是有多重嵌套时，为了使层次清晰，应当在一些段落的 

结束处加注释（在闭合的右花括号后注释该闭合所对应的起点），注释不能 

写得很长，只要能表示是哪个控制语句控制范围的结束即可，这样便于阅读。 

3、将注释与注释分隔符用一个空格分开，在没有颜色提示的情况下查看注释时， 

这样做会使注释很明显且容易被找到。 

4、不允许给块注释的周围加上外框。这样看起来可能很漂亮，但是难于维护。 

5、每行注释（连同代码）不要超过120个字(1024×768)，最好不要超过80 

字(800×600) 。 

6、Java编辑器（IDE）注释快捷方式。Ctrl+/ 注释当前行,再按则取消注释。 

7、对于多行代码的注释，尽量不采用“/*......*/”，而采用多行“//”注释， 

这样虽然麻烦，但是在做屏蔽调试时不用查找配对的“/*......*/”。 

8、注释作为代码切换开关，用于临时测试屏蔽某些代码。

JeeSpringCloud-互联网云快速开发框架

（一款免费开源的JAVA互联网云快速开发平台）微服务分布式代码生成的敏捷开发系统架构。项目代码简洁,注释丰富,上手容易,还同时集中分布式、微服务,同时包含许多基础模块和监控、服务模块。

演示版地址：

一、平台简介

在线文档：

视频和文档下载：

开源中国地址：

文档视频下载：

JeeSpringCloudV3.0-互联网云快速开发框架模块包含定时任务调度、服务器监控、平台监控、异常邮件监控、服务器Down机邮件监控、平台设置、开发平台、邮件监控、图表监控、地图监控、单点登录、Redis分布式高速缓存、

ActiveMQ队列、会员、营销、在线用户、日志、在线人数、访问次数、调用次数、直接集群、接口文档、生成模块、代码实例、安装视频、教程文档、dubbo、springCloud、SpringBoot、mybatis、springmvc、IOC、AOP、定时任务、切面缓存、MVC、事务管理。

RedisMQ队列、代码生成(单表、主附表、树表、列表和表单、增删改查云接口、redis高速缓存对接代码、图表统计、地图统计、vue.js)、工作流、模块化

代码生成前端控件包括单行文本、富文本、下拉选项、复选框、日期选择、文件上传选择、树选择控件、单选按钮、多行文本….。

二、平台功能

用户管理：用户是系统操作者，该功能主要完成系统用户配置。

部门管理：配置系统组织机构（公司、部门、小组），树结构展现支持数据权限。

岗位管理：配置系统用户所属担任职务。

菜单管理：配置系统菜单，操作权限，按钮权限标识等。

角色管理：角色菜单权限分配、设置角色按机构进行数据范围权限划分。

字典管理：对系统中经常使用的一些较为固定的数据进行维护。

参数管理：对系统动态配置常用参数。

通知公告：系统通知公告信息发布维护。

操作日志：系统正常操作日志记录和查询；系统异常信息日志记录和查询。

登录日志：系统登录日志记录查询包含登录异常。

在线用户：当前系统中活跃用户状态监控。

定时任务：在线（添加、修改、删除)任务调度包含执行结果日志。

代码生成：前后端代码生成(单表、主附表、树表、列表和表单、增删改查云接口、redis高速缓存对接代码、图表统计、地图统计、vue.js) ，并生成菜单和权限直接使用。

系统接口：根据业务代码自动生成相关的api接口文档。

连接池监视：监视当期系统数据库连接池状态，可进行分析SQL找出系统性能瓶颈。

在线接口文档：使用swager生成在线文档。

ActiveMQ队列:提供ActiveMQ队列，处理批量发送大数据量邮件、大数据量日志文件。

工作流：功能包括在线办公、我的任务、审批测试、流程管理、模型管理。

CMS：功能包括内容管理、内容管理、统计分析、栏目设置、首页。

dubbo:代码生成直接生成dubbo对接代码。

服务器Down机邮件监控:通过定时任务监控服务器是否Down机，并发送通知邮件。

服务器监控:通过 sigar 进行服务器图形化监控。

异常邮件监控:全局拦截系统异常，并发送通知邮件。

单点登录:使用shior和Redis、共享session方式实现单点登录。

Redis分布式高速缓存:代码生成直接生成Redis对接代码。

三、系统截图

JeeSpringCloudV3.0-互联网云快速开发框架（后台）

四、平台特性

JeeSpringCloud基于SpringBoot+SpringMVC+Mybatis+Redis+SpringCloud+Vue.js微服务分布式代码生成的敏捷开发系统架构。项目代码简洁,注释丰富,上手容易,还同时集中分布式、微服务,同时包含许多基础模块(用户管理,角色管理,部门管理,字典管理等10个模块。成为大众认同、大众参与、成就大众、大众分享的开发平台。JeeSpring官方qq群(328910546)。代码生成前端界面、底层代码（spring mvc、mybatis、Spring boot、Spring Cloud、微服务的生成）、安全框架、视图框架、服务端验证、任务调度、持久层框架、数据库连接池、缓存框架、日志管理、IM等核心技术。努力用心为大中小型企业打造全方位J2EE企业级平台ORM/Redis/Service仓库开发解决方案。一个RepositoryService仓库就直接实现dubbo、微服务、基础服务器对接接口和实现。

努力用心为大中小型企业打造全方位J2EE企业级平台开发解决方案。

Spring Boot/Spring cloud微服务是利用云平台开发企业应用程序的最新技术，它是小型、轻量和过程驱动的组件。微服务适合设计可扩展、易于维护的应用程序。它可以使开发更容易，还能使资源得到最佳利用。

微服务/集群(nignx) 支持REST风格远程调用（HTTP + JSON/XML)：基于非常成熟的Spring Boot框架，在Spring Boot Spring Cloud中实现了REST风格（HTTP + JSON/XML）的远程调用，以显著简化企业内部的跨语言交互，同时显著简化企业对外的Open API、无线API甚至AJAX服务端等等的开发。

事实上，这个REST调用也使得Dubbo可以对当今特别流行的“微服务”架构提供基础性支持。 另外，REST调用也达到了比较高的性能，在基准测试下，HTTP + JSON默认的RPC协议（即TCP + Hessian2二进制序列化）之间只有1.5倍左右的差距，详见下文的基准测试报告。

ORM/Redis/Service仓库

RepositoryORM仓库,提供ORM接口和多种实现,可进行配置实现。

RepositoryRedis仓库,提供Redis接口和多种实现,可进行配置实现。可以配置调用单机、redis、云redis对接。

RepositoryService仓库,提供Service接口和多种实现,可进行配置实现。一个RepositoryService仓库就直接实现dubbo、微服务、基础服务器对接接口和实现。

五、架构说明

技术选型

六、代码生成器

代码生成器

七、开发入门

平台教程：

官方提供：

1、详细部署文档。

2、部署视频。

3、中级培训视频待定，包括代码生成、架构代码介绍。

4、高级培训视频待定，包括架构代码详解。

5、架构培训视频待定，包括架构详解、代码生成详解。

平台教程：

八、在线体验

演示版地址：

如何快速的学好java？

好的学习方法对于你的学习至关重要，对于每一个刚开始学习Java的程序员新人来说，都希望有一种快速学习的方法，漫无目的和长时间的学习很容易消耗你的信息，最后学的混乱，也没有实质性的收获，以至于学习到最后越来越焦虑。

初学者想要快速学习Java技术的心情大家都可以理解，但是有一句话：欲速则不达。盲目的追求快并不能达到理想的学习效果，问题来了，那么作为Java新人如何快速的学习Java编程呢？

新人学习进步非常缓慢，是因为很多的Java难题自己都没有办法解决，身边没有懂技术的人，所以只能一直在网上苦苦查找答案，就算你找到了解答，但是也不一定能够保证是对的。

初学者如何快速学Java?

方法1：Java初学者可以加入一个比较好的Java学习交流群，或者论坛，群不需要加的太多，在群中提出问题，有时候其他人的只言片语也可以帮助你走出困境。多与技术好的人交流沟通，你的技术才能变得更好。比如我的这个技术交流群

我创建的Java自学交流裙，前面输入是：926中间是：452最后连起来：303，需要java最新录制视频教程及学习路线，开发工具，jar包。源码等都可以找我，有遇见任何问题都可以随时来交流，只有不断的碰撞和交流，我们才能发现解决自己的问题，以此取长补短。

方法2：对于初学者来说快速学Java，还有一个有效的办法就是收集有用代码和工具，一些代码是可以重复使用的，随着你Java代码的练习越来越多，你对Java代码编写越来越得心应手，你就会发现你之前搜集的有用的代码和工具，大大节省了你敲代码的时间，比如工具类的：StringUtils(字符串工具)，DBUtils(数据库工具)等等。

方法3：养成良好的记录笔记的习惯，因为在快速学习Java的过程中，记录显得尤为重要，比如在Java学习中，把你碰到的问题，或者突然间的奇思妙想记录下来，不时翻翻，你会很清楚你一路以来的学习历程是怎样的。

它不仅是你Java学习的成长日记，更是鼓励支持你坚持学Java的好法宝，还可以成为你Java学习的动力源泉。

好的学习方法再加上良好的习惯，你会发现学习Java也不是一件多么困难的事情。当然，以上这些方法适用于那些有足够时间学习，或者是有较强自控力的人，如果你面临的就业，面临着经济问题，很难有一颗平常心去好好学习。

总之，学好Java技术才你才能享受生活带来的乐趣，为了你的梦想，努力学习吧。

有哪些适合java初学者的项目？

20个当时初学时的Java 练手项目，结尾提供项目源码。

需要可以群文件自行下载

请点击输入图片描述

名称栏目：java敏捷开发代码 敏捷开发视频教程
分享网址：http://hbruida.cn/article/doedhjs.html