实际工作中的java代码 java实际运用

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

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

一、背景 

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、注释作为代码切换开关，用于临时测试屏蔽某些代码。

相关问答

Q1: 实际工作中Java写什么样的程序居多？

C/S程序都是有客户端的 因为java 追求的跨平台性 所以用户界面基本上控件大多都是用自己的（不是所有都是），并不调用操作系统的控件。所以做出来的界面大多都是一个样 ，比较死板 。而调用系统的控件的又会对跨平台有影响。违背了java 一次编译到处运行的理念。java比较适合写后台程序。所以c/s程序才写不多的原因吧 以上只是个人意见 不要尽信

Q2: 现实世界中哪些地方用到了Java？

1、学习培训Java能够建立网站 Java能够用于编写网站，如今许多商业网站都用Jsp写的，JSP全称Java Server Pages。它是一种动态网站技术性，例如大家了解的163，一些政府门户网站全是选用JSP撰写的。 因此学习培训Java的同学们能够找开发网站层面的工作中，并且如今找这些方面的职位比较多。 例如：网站建设，自然便是JSP+Servlet+JavaBean，一直以来都非常时兴。 2、学习培训Java能够做Android Android是一种根据Linux的随意及对外开放源码的电脑操作系统，其源码是Java。 因此销售市场上看到的手机的系统比如MIUI，阿里云服务器，乐蛙等，全是改动源码再发售的。 Java做安卓系统不仅仅是指系统软件，也有APP针对大量的开发者而言，她们大量的时间花在开发设计APP上边。 3、学习培训Java能做游戏 你可能不知道，在之前Nokia还很时兴的情况下，你玩的游戏有90%之上全是Java开发设计的。自然如今早已非常少人再去开发设计了，都转至安卓系统上来了。电脑也是有Java开发设计的手机游戏，最经典的是：《我的世界》(minecraft，通称MC)，当今社会最具人气值和知名度的网游之一《英雄联盟》(通称lol)。

Q3: Java语言在实际开发工作中能用到些什么技术呢？

Java语言有J2SE\J2EE\J2ME，分别是用于桌面开发，Web开发，移动开发，这三个看意思是做什么的也能够大概猜个八九不离十了。不同的开发，需要用到的技术是不同的。另外，实际工作中的java代码你这个技术讲的也比较含糊。整个Java是语言，但语言也是技术啊，所以用Java开发自然用到的就是Java技术了。

当然，撇开语言来说，那就是一般的程序开发都会用到的一些语言以外的技术了。比如，实际工作中的java代码你做游戏开发，那就要用到线程，用到数据库技术，做网站或者说B/S设计，那就设计到网络了，那就要用到Tomcat服务器搭建，存放数据表单就要用到数据库了，用到Servlet和jsp，设计模式就用到Structs+ Spring + Hibernate，用到EJB了。而移动开发，自然要了解你设计的移动设备的硬件方面的知识了。

额，实际上，你需要知道的是，Java的功能是非常强大的，甚至可以数，除了最底层的东西，很少有人专门用Java来做，其它的都可以用java，而所有的软件都是语言编的，你等于是问，程序设计在开发中能用到哪些技术实际工作中的java代码！实际工作中的java代码！

Q4: 做java软件工程师，怎样才能写出好的代码？

Java代码之于java程序员而言就是左膀右臂，java代码写的好的java程序员明显更是企业的欢迎，一个优秀的java程序员的考核标准之一也是看他的编程水平。

其实有的java程序员java代码会受到大家的追捧，是因为他在写代码时注意的细节往往多于那些不怎么关注java代码编程细节的程序员，俗话说：“细节决定成败”，那么如何写出好的java代码呢？IT培训介绍一起来讨论下：

1.重视注释

有的java程序员在写代码时，从来没有想过要在java代码后加上相关的注释，甚至是上万行的代码也没有想过加上注释，这就存在很大的问题，不说你的代码会跟其他人分享讨论，就你自己回顾你是怎么写好这篇代码的，你也是半天无法理出头绪，这就为维护和修改等等工作添加了很大的麻烦。所以，要想写出好的java代码，一定从简短的java代码编写开始注重在java代码后面加上相应的注释，养成良好的习惯。

2.重视排版整洁

看很多java程序员的排版总觉得在欣赏一幅艺术品，但是看到一些java程序员的排版却总觉得无力吐槽。同样是编写代码，但是给人的视觉体验是相当的不同，当然好的java代码给人的享受也是美的，所以要想写出好的代码，一定要重视排版整洁。

3.注重命名规则

现在在一个团队开发中，都会提前定制一个统一的命名规则，这样利于提高工作效益。但是很多java程序员是缺乏这个意识的，每次敲代码，更喜欢按照自己惯常的方式老命名模块、函数，这样是方便了自己，但是忽视团队协作，所以在日常工作中，特别是团队工作中一定要重视命名规则。

4.养成备份习惯

备份的重要性不用小编强调，相必你也知道。但是有的java程序员就是没有养成这样的好习惯，每次敲完代码就不记得随手保存，每次等到除了事故，比如电脑出了故障，辛辛苦苦敲打的java代码没保存找不回来的情况下就开始懊恼，与其这样还不如在一开始就养成良好的备份习惯，这样也方便自己日后查找利用。

实际工作中的java代码的介绍就聊到这里吧，感谢你花时间阅读本站内容，更多关于java实际运用、实际工作中的java代码的信息别忘了在本站进行查找喔。