高手代码风格java 代码编程java

java学习：如何写出高质量的代码，成功进入BAT

很多问题归根结底都是技术债务，这在一些大公司尤为常见。技术债务话题太大，但就代码质量而言，我只想提一下不要因为这些债是前人留下的你就不去管。怎么写出高质量的代码呢？

1、打好技术基础

写出高质量代码，并不是搭建空中楼阁，需要有一定的基础。这里我重点强调与代码质量密切相关的几点：

1）掌握好开发语言

比如做 Android 就必须对 Java 足够熟悉，才能够写出高质量 Java 代码。

2）熟悉开发平台

不同的开发平台，有不同的 API，有不同的工作原理，同样是 Java 代码，在 PC 上写与 Android 上写很多地方不一样。

3）要去熟悉 Android 编程的一些特性

iOS 编程的一些特性，了解清楚这些，才能写出更加地道的代码，充分发挥各自平台的优势。

4）基础的数据结构与算法

掌握好这些在解决一些特定问题时，可以以更加优雅有效的方式处理。

5）基础的设计原则

无需完全掌握 23 种经典设计模式，只需要了解一些常用的设计原则即可，甚至你也可以只了解什么是低耦合，并在你的代码中坚持实践，也能写出很不错的代码。

2、代码标准

代码标准在团队合作中尤为重要，谁也不希望一个项目中代码风格各异，看得让人糟心，即便是个人开发者，现在也需要跟各种开源项目打交道。

标准怎么定是一个老生常谈的话题，我经历过很多次的代码标准讨论会议，C++，C#，Java 等等，大家有时会坚持自己的习惯不肯退让。可现如今时代不一样了，Google 等大厂已经为我们制定好了各种标准，就用这些业界标准吧。

3、想好再写

除非你很清楚你要怎么做，否则我不建议边做边想。你真的搞清楚你要解决的问题是什么了吗？你的方案是否能有效？有没有更优雅简单的方案？

准备怎么设计它，必要的情况下，需要有设计文档，复杂一些的设计需要有同行评审，写代码其实是很简单的事情，前提是你得先想清楚。

4、代码重构

重构对于代码质量的重要性不言而喻，很难一次把代码写得让自己满意、无可挑剔。

5、技术债务

很多问题归根结底都是技术债务，这在一些大公司尤为常见。技术债务话题太大，但就代码质量而言，我只想提一下不要因为这些债是前人留下的你就不去管。

现实是没有多少机会让你从一个清爽清新的项目开始做起，你不得不去面对这些，你也没法完全不跟这些所谓的烂代码打交道。

当你负责一个小模块时，除了把它做好之外，也要顺便将与之纠缠在一起的技术债务还掉，因为这些债务最终将是整个团队来共同承担，任何一个人都别想独善其身，如果你还对高质量代码有追求的话。

作为团队的技术负责人，也要顶住压力，鼓励大家勇于做出尝试，引导大家不断改进代码质量，不要总是畏手畏脚，停滞不前，真要背锅也得上，要有担当。

6、代码审查

我曾经听过一些较高级别的技术分享，竟然还不时听到一些呼吁大家要做代码审查的主题。

我以为在这个级别的技术会议上，不应再讨论代码审查有什么好，为什么要做代码审查之类的问题。同时我接触过相当多所谓国内一线互联网公司，竟有许多是不做代码审查的，这一度让我颇为意外。

这里也不想多谈如何做好代码审查，只是就代码质量这点，不客气地说：没有过代码审查的经历往往很难写出高质量的代码，尤其是在各种追求速度的糙快猛创业公司。

7、静态检查

很多代码上的问题，都可以通过一些工具来找到，某些场景下，它比人要靠谱得多，至少不会出现某些细节上的遗漏，同时也能有效帮助大家减少代码审查的工作量。

Android 开发中有 Lint，Find bugs，PMD 等优秀静态检查工具可用，通过改进这些工具找出的问题，就能对语法的细节，规范，编程的技巧有更多直观了解。

建议最好与持续集成(CI)，代码审查环境配套使用， 每次提交的代码都能自动验证是否通过了工具的代码检查，通过才允许提交。

8、单元测试

Android 单元测试，一直备受争议，主要还是原生的测试框架不够方便，每跑一次用例需要在模拟器或者真机上运行，效率太低，也不方便在 CI 环境下自动构建单元测试，好在有 Robolectric，能帮我们解决部分问题。

单元测试的一个非常显著的优点是，当你需要修改大量代码时，尽管放心修改，只需要保证单元测试用例通过即可，无需瞻前顾后。

9、充分自测

有一种说法：程序员最害怕的是他自己写的代码，尤其是准备在众人面前 show 自己的工作成果时，因此在写完代码后，需要至少跑一遍基本的场景，一些简单的异常流。

在把你的工作成果提交给测试或用户前，充分自测是基本的职业素养，不要总想着让测试帮你找问题，随便用几下就 Crash 的东西，你好意思拿给别人吗？

10、善用开源

并非开源的东西，质量就高，但至少关注度较高，使用人数较多，口碑较好的开源项目，质量是有一定保证的，这其中的道理很简单。

即便存在一些问题，也可以通过提交反馈，不断改进。最重要的是，你自己花时间造的轮子，需要很多精力维护，而充分利用开源项目，能帮助你节省很多时间，把精力专注在最需要你关心的问题上。

从另一个方面来说，开源项目中的一些知名项目，往往是领域内的翘楚所写，学习这些高手的代码，能让你了解到好的代码应该是怎样的，培养出更灵敏的嗅觉，识别代码中的各种味道

Java高手是怎样炼成的？

Java高手是怎么炼成的，你猜。

高手代码风格java他们说当你精通这25个学习点，一切都水到渠成高手代码风格java了。

01

你需要精通面向对象分析与设计(OOA/OOD)、涉及模式(GOF，J2EEDP)以及综合模式。你应该高手代码风格java了解UML，尤其是class、object、interaction以及statediagrams。

02

你需要学习Java语言的基础知识以及它的核心类库(collections、serialization、streams、networking、multithreading、reflection、event、handling、NIO、localization以及其他)。

03

你应该了解JVM、classloaders、classreflect以及垃圾回收的基本工作机制等。你应该有能力反编译一个类文件并且明白一些基本的汇编指令。

04

如果你将要写客户端程序，你需要学习Web的小应用程序(applet)，必需掌握GUI设计的思想和方法，以及桌面程序的SWING、AWT、SWT。你还应该对UI部件的JavaBEAN组件模式有所了解。JavaBEANS也被应用在JSP中以把业务逻辑从表现层中分离出来。

05

你需要学习Java数据库技术，并且会使用至少一种persistence/ORM构架，例如hibernate、JDO、CocoBase、TopLink、InsideLiberator(国产JDO红工厂软件)或者iBatis。

06

你还应该了解对象关系的阻抗失配的含义以及它是如何影响业务对象与关系型数据库的交互，和它的运行结果。还需要掌握不同的数据库产品运用，比如Oracle、MySQL、SQLserver。

07

你需要学习Servlets、JSP，以及JSTL(StandardTagLibraries)和可以选择的第三方TagLibraries。

08

你需要熟悉主流的网页框架，例如JSF、Struts、Tapestry、Cocoon、WebWork，以及他们下面的涉及模式，如MVC/MODEL2。

09

你需要学习如何使用及管理Web服务器，例如tomcat、resin、Jrun，并且知道如何在其基础上扩展和维护Web程序。

10

你需要学习分布式对象以及远程API，例如RMI和RMI/IIOP。

11

你需要掌握各种流行中间件技术标准和与Java结合实现，比如Tuxedo、CROBA，当然也包括JavaEE本身。

12

你需要学习最少一种的XMLAPI，JAXP(JavaAPIforXMLProcessing)、JDOM(JavaforXMLDocumentObjectModel)、DOM4J或JAXR(JavaAPIforXMLRegistries)。

13

你应该学习如何利用Java的API和工具来构建WebService。例如JAX-RPC(JavaAPIforXML/RPC)、SAAJ(SOAPwithAttachmentsAPIforJava)、JAXB(JavaArchitectureforXMLBinding)、JAXM(JavaAPIforXMLMessaging)、JAXR(JavaAPIforXMLRegistries)或者JWSDP(JavaWebServicesDeveloperPack)。

14

你需要学习一门轻量级应用程序框架，例如spring、PicoContainer、Avalon，以及它们的IoC/DI风格(setter，constructor，interfaceinjection)。

15

你需要熟悉不同的J2EE技术，例如JNDI(JavaNamingandDirectoryInterface)、JMS(JavaMessageService)、JTA/JTS(JavaTransactionAPI/JavaTransactionService)、JMX(JavaManagementeXtensions)，以及JavaMail。

16

你需要学习企业级JavaBeans(EJB)以及它们的不同组件模式：Stateless/StatefulSessionBeans、EntityBeans(包含Bean-ManagedPersistence[BMP]或者Container-ManagedPersistence[CMP]和它的EJB-QL)，或者Message-DrivenBeans(MDB)。

17

你需要学习如何管理与配置一个J2EE应用程序服务器，如WebLogic、JBoss等，并且利用它的附加服务，例如簇类，连接池以及分布式处理支援。你还需要了解如何在它上面封装和配置应用程序并且能够监控、调整它的性能。

18

你需要熟悉面向方面的程序设计以及面向属性的程序设计(这两个都被很容易混淆的缩写为AOP)，以及他们的主流Java规格和执行。例如AspectJ和AspectWerkz。

19

你需要熟悉对不同有用的API和framework等来为你服务。例如Log4J(logging/tracing),Quartz(scheduling),JGroups(networkgroupcommunication),JCache(distributedcaching),Lucene(full-textsearch),JakartaCommons等等。

20

你应该熟练掌握一种JavaIDE例如sunOne、netBeans、IntelliJIDEA或者Eclipse。(有些人更喜欢VI或EMACS来编写文件。随便你用什么了)

21

Java(精确的说是有些配置)是冗长的，它需要很多的人工代码(例如EJB)，所以你需要熟悉代码生成工具，例如XDoclet。

22

你需要熟悉一种单元测试体系(JNunit)，并且学习不同的生成、部署工具(Ant，Maven)。

23

你需要熟悉一些在Java开发中经常用到的软件工程过程。例如RUP(RationalUnifiedProcess)andAgilemethodologies。

24

你还需要紧跟Java发展的步伐，比如现在可以深入的学习Webwork2.0。

25

你必需要对实际项目的开发流程有所了解，至少要有两个有实际应用价值的项目，而不是练习项目!因为现在企业看重的是你有没有实际的开发经验，真正开发经验的体现就是你做的项目，也就是有实际应用的项目!

什么是良好的编程风格（Java编程）

首先,编程风格并不同于其他的style，目的并不是形成自己独树一帜的风格，而是为了让你的程序易读,有利于团队合作以及别人帮你改错。

风格是通用的

C语言和C++语言的编程风格 （Java见下）

第一章:缩进格式

Tab是8个字符,于是缩进也是8个字符.有很多怪异的风格,他们将缩进格式定义为4个字符(设置为2个字符!)的深度,这就象试图将PI定义为3一样让人难以接受.

理由是:缩进的大小是为了清楚的定义一个块的开始和结束.特别是当你已经在计算机前面呆了20多个小时了以后,你会发现一个大的缩进格式使得你对程序的理解更容易.

现在,有一些人说,使用8个字符的缩进使得代码离右边很近,在80个字符宽度的终端屏幕上看程序很难受.回答是,但你的程序有3个以上的缩进的时候,你就应该修改你的程序.

总之,8个字符的缩进使得程序易读,还有一个附加的好处,就是它能在你将程序变得嵌套层数太多的时候给你警告.这个时候,你应该修改你的程序.

第二章:大符号的位置

另外一个C程序编程风格的问题是对大括号的处理.同缩进大小不同,几乎没有什么理由去选择一种而不选择另外一种风格,但有一种推荐的风格,它是Kernighan和Ritchie的经典的那本书带来的,它将开始

的大括号放在一行的最后,而将结束大括号放在一行的第一位,如下所示:

if (x is true) { we do y }

然而,还有一种特殊的情况:命名函数:开始的括号是放在下一行的第一位,如下:

int function(int x) { body of function }

所有非正统的人会非难这种不一致性,但是,所有思维正常的人明白: (第一) KR是___对___的,(第二)如果KR不对,请参见第一条. (:-))......另外,函数也是特殊的,不一定非得一致.

需要注意的是结束的括号在它所占的那一行是空的,__除了__它跟随着同一条语句的继续符号.如"while"在do-while循环中,或者"else"在if语句中.如下:

do { body of do-loop } while (condition);

以及

if (x == y) { .. } else if (x y) { ... } else { .... }

理由: KR.

另外,注意到这种大括号的放置方法减小了空行的数量,但却没有减少可读性.于是,在屏幕大小受到限制的时候,你就可以有更多的空行来写些注释了.

第三章:命名系统

C是一种简洁的语言,那么,命名也应该是简洁的.同MODULE-2以及ASCAL语言不同的是,C程序员不使用诸如ThisVariableIsATemporaryCounter之类的命名方式.一个C语言的程序员会将之命名为"tmp",这很容易书写,且并不是那么难以去理解.

然而,当混合类型的名字不得不出现的时候,描述性名字对全局变量来说是必要的了.调用一个名为"foo"全局的函数是很让人恼火的.全局变量(只有你必须使用的时候才使用它) ,就象全局函数一样,需要描述性的命名方式.假如你有一个函数用来计算活动用户的数量,你应该这样命名--"count_active_users()"--或另外的相近的形式,你不应命名为"cntusr()".

有一种称为Hungarian命名方式,它将函数的类型编码写入变量名中,这种方式是脑子有毛病的一种表现---编译器知道这个类型而且会去检查它,而这样只会迷惑程序员. --知道为什么Micro$oft为什么会生产这么多"臭虫"程序了把!!.

局部变量的命名应该短小精悍.假如你有一个随机的整数循环计数器,它有可能有"i",如果没有任何可能使得它能被误解的话,将其写作"loop_counter"是效率低下的.同样的,""tmp"可以是任何临时数值的函数变量.

如果你害怕混淆你的局部变量的名字,还有另外一个问题,就是称

function-growth-hormone-imbalancesyndrome.

第四章:函数

函数应该短小而迷人,而且它只作一件事情.它应只覆盖一到两个屏幕(80*24一屏),并且只作一件事情,而且将它做好.(这不就是UNIX的风格吗,译者注).

一个函数的最大长度和函数的复杂程度以及缩进大小成反比.于是,如果你已经写了简单但长度较长的的函数,而且你已经对不同的情况做了很多很小的事情,写一个更长一点的函数也是无所谓的.

然而,假如你要写一个很复杂的函数,而且你已经估计到假如一般人读这个函数,他可能都不知道这个函数在说些什么,这个时候,使用具有描述性名字的有帮助的函数.

另外一个需要考虑的是局部变量的数量.他们不应该超过5-10个,否则你有可能会出错.重新考虑这个函数,将他们分割成更小的函数.人的大脑通常可以很容易的记住7件不同的事情,超过这个数量会引起混乱.你知道你很聪明,但是你可能仍想去明白2周以前的做的事情.

第5章:注释

注释是一件很好的事情,但是过多的注释也是危险的,不要试图区解释你的代码是注释如何如何的好:你应该将代码写得更好,而不是花费大量的时间去解释那些糟糕的代码.

通常情况下,你的注释是说明你的代码做些什么,而不是怎么做的.而且,要试图避免将注释插在一个函数体里:假如这个函数确实很复杂,你需要在其中有部分的注释,你应该回到第四章看看.你可以写些简短的注释来注明或警告那些你认为特别聪明(或极其丑陋)的部分,但是你必须要避免过多.取而代之的是,将注释写在函数前,告诉别人它做些什么事情,和可能为什么要这样做.

第六章:你已经深陷其中了.

不要着急.你有可能已经被告之"GUN emacs"会自动的帮你处理C的源代码格式,而且你已经看到它确实如此,但是,缺省的情况下,它的作用还是不尽如人意(实际上,他们比随便敲出来的东西还要难看- ainfinite number of monkeys typing into GNU emacs would never make a good program)

于是,你可以要么不要使用GUN emacs,要么让它使用sanervalules.使用后者,你需要将如下的语句输入到你的.emacs文件中.(defun linux-c-mode() "C mode with adjusted defaults for use with the Linux kernel."(interactive) (c-mode) (c-set-style"KR") (setq c-basic-offset8))

这会定义一个M-x Linux-c-mode的命令.当你hacking一个模块的时候,如何你将-*- linux-c -*-输入在最开始的两行,这个模式会自动起作用.而且,你也许想加入如下

(setq auto-mode-alist (cons '("/usr/src/linux.*/.*.〖ch〗$" . linux-c-mode) auto-mode-alist))

到你的.emacs文件中,这样的话,当你在/usr/src/linux下编辑文件的时候,它会自动切换到linux-c-mode .

但是,假如你还不能让emaces去自动处理文件的格式,不要紧张,你还有一样东西: "缩进" .

GNU的缩进格式也很死板,这就是你为什么需要加上几行命令选项.然而,这还不算太坏,因为GNU缩进格式的创造者也记得KR的权威, (GNU没有罪,他们仅仅是在这件事情上错误的引导了人们) ,你要做的就只有输入选项"-kr -i8"(表示"KR,缩进8个字符).

"缩进"有很多功能,特别是当它建议你重新格式你的代码的时候,你应该看看帮助.但要记住: "缩进"不是风格很差的程序的万灵丹.

JAVA编程风格简析

很久以来都在体会着JAVA的风格，现在做一简单陈述，希望大家多提宝贵意见。

对于一种好的编程语言，学习它的编程风格是很重要的。每种语言都有自己的编写和注释约定，当然所有语言都建立在最基本的约定之上。编程中最重要的并不是让代码按自己希望的方式运行，而是程序中那种自明的编程风格（这对于程序员的益处相信众多程序员都身有体会）！但这还不够，程序还应该具有可读、相对持久和可维护性。可读性非常重要，因为你不希望自己以前的作品在之后的阅读中给自己留下障碍，当然，更重要的是自己的程序能让其他程序员读懂并且修改。

下面高手代码风格java我把工作中所理解的java风格做一简单总结，这是我所理解的好的编程风格和应用中我们应当如何使用java编写自己的代码的小Guide。这并不完全，希望大家帮我陆续总结各自的经验。

一般性概述

好的编程风格固然重要，但是你一定听说过一些程序员的个人风格。其实我们完全不必为那些所谓条条框框所累，但是作为原则是我们至少不能打破这些常规。我们应该在保持自己风格的同时尽量的把自己与编程潜原则靠拢。

可读性很容易达到，比如，让自己的代码缩排排列、名字采用描述性但不要过长（短名应仅仅用在非远程）、特殊名称比如pi应当被定义为final类型。模块性是编程需要注意的另一重点，把代码划分到类里，在类中把功能划分到方法中，别让一个类太大，否则在使用、修改和理解上都会造成不必要的麻烦，方法也一样，如果一个方法长度超过50行，它产生错误的概率将接近100％，尽量把大方法划分为小方法，编程中为避免重复编写，还应尽量调用JAVA标准类库。

尽量避免在写代码和注释时使用不同语言，经常见到论坛有朋友询问诸如在java中调用c、调用php、调用shell之类的问题，其实在编程中，我们应尽量使用一种语言去完成事情。另外就是不必最优化自己的代码，应该选择相对较优的算法就可以了。

类、方法和fields

类应体现出某种物质的基本概念，比如要编程实现“汽车”的组成，那么所有的汽车都可以用类Car实现。这个类应当包括域描述、属性描述和car的状态（color, number of doors, age等）和由car可完成的操作（getColor, setColor等）。为了提高类的可重用性，不要在类中有过多的描述，当然这也会增加错误产生的机会。

类名首字母大写，比如Date, String, Hashtable等 ... ...

类如下定义：(未使用Javadoc做注释):

public class Car {

/* Instance variables are placed either in the beginning

or at the end of the class */

private int age;

private Color color;

/* The constructor should be placed in the beginning */

public Car(int age, Color color) {

this.age = age;

this.color = color;

}

/* Example method */

public int getAge() {

return age;

}

/* The main method is optional, but looks like this.

If it exists, it is either the first or the last

method in the class */

public static void main(String [] args) {

...

}

}

注意类名和大括号间的空格！

方法

方法一般定义为public。当然，如果方法仅仅在当前类用到可以定义为private，而如果希望一个子类沿用这个方法则不同，这时候的方法应定义为protected。

java中的方法定义很有趣，它们一般小写字母开头，如果有两个字组成，第二个字的首字母则大写。因此名字的描述性是至关重要的。这使你不用阅读整篇代码来判断这是一个什么方法。在给自己的方法取名时应尽量不要太短或者太长，另一个需要注意的是大多方法使用动词（动宾短语）。

例如：

public void eat() {}

public void eatBananas() {}

Selector（选择器）方法有get前缀，后缀是它们将要get的，比如

public int getBananas() {}

Mutator（存取器）方法则有set前缀，后缀则是他们要set的，比如

public void setBananas(int amount) {}

注意mutators大多无返回值。

方法的参数应当以如下方式给出：

public void aMethod(type parameter1, type parameter2, ... , type parametern) {}

如果参数过长，也可以断开为几行，应对齐向下排列如：

public void aMethod(type parameter1, type parameter2,... ,

type parametern, type parameter n+1,... ,

type parameterm, type parameter m+1) {}

另外要注意类的左束括号应在方法的右束括号之后而非下一行:

public int aMethod() {

int i = 0;

if(i == 0)

System.out.println("success！");

}

为了文件可读性好，还要注意语句最好写在同一行，当然一行写不下是可以断行的，比如行字母超过80。

fields

比如变量，如果不希望它永久有效，应设为private。如果一个变量在类中不发生任何动作（比如数据结构中的node）则可以设置为public，常量一般声明为public。如果不能确定一个变量到底该声明为什么，应暂且声明为private。

field的名字一般使用小写字母，不要使用下横线或其他特殊字符。 如果变量包含两个字，那么第二个字的首字母大写。比如：

int i, j, k;

Date date;

double myField;

常量一般全部大写，也可以包含下横线：

public static final int MAX_SIZE_OF_DATABASE

fields的名字通常为名词。较重要的fields更应具备描述性，比如程序中包含一个游戏的得分，那可以用score来代表。如果变量变化较频繁，那使用一个单一字符来代表就ok了：

i, j, k 通常代表整数

r, t, u, v, w 通常代表实数

x, y, z 通常是并列出现或代表浮点数

s, s1, s2, 通常代表字符串

c, ch 通常代表字符

f, file 通常代表文件

tmp, temp 通常代表临时变量

ctr, cnt, cntr 一般代表计数器(如果i, j, k这些变量已被使用)

dummy, foo, bar 一般代表哑元变量

args 是main-method的主参数名

缩排与换行

每行长度不得超过80字符。如果需要可以折行时，也应当与上一行有共同的缩排距离。代码应如何交错、如何建立新行、在哪里建立允许、哪里不允许都有一些一般约定，缩排空格一般为2个或4个空格。

条件表达式

如果见到如下语法表达式：

if (expr)

statement1;

else

statement2;

代码行向右错排两个空格如上所示。

如果在一个表达式中有超过一条的声明，则需要大括号:

if (expr){

statement1;

statement2;

} else{

statement3;

statement4;

}

有时我们会希望在表达式中使用表达式（比如条件嵌套），这时应注意else表达式，它的位置很容易出错！如例：

if (expr1) {

statement1;

statement2;

} else if (expr2)

statement3;

else if (expr3) {

statement4;

statement5;

} else {

statement6;

statement7;

}

注意大括号位置！

Loops

while-loop语法如下：

while (expr) {

statement1;

statement2;

}

for-loop语法如下：

for (expr1; expr2; expr3){

statement1;

statement2;

}

注意大括号位置！仅一条声明时大括号省略：

while (expr)

statement;

for (expr1; expr2; expr3)

statement;

例如，我们写一个procedure写出1到10这十个数字：

for (i = 1; i = 10; i++)

System.out.println(i);

try-catch语法形如：

try {

statements;

} catch (ExceptionClass e) {

statements;

}

如果try-catch语句后跟随finally子句则形如：

try {

statements;

} catch (ExceptionClass e) {

statements;

} finally {

statements;

}

新行

每一行最好只阐述一件事情。比如，一行包含一个声明、一个条件语句、一个循环等。不论多小，最好不要一行办两件事及以上。例如不要把一个if表达式或循环语句的主体放置在同一行，这样的表达式断行的易读性会更高。通常，互相协作的代码应放在一起，为保证代码美观可读，我们应将代码的不同代码段放置在不同的段落。不过要牢记断行不要太过分！比如:

public int factorial(int n) {

int result = 1;

for(int i = 1; i = n; i++)

result*=i;

return result;

}

给自己的代码加入注释

注释就是类的描绘、方法存在的原因、它完成了什么以及它对它其中（变量）的作用域。假定阅读你代码的人已经知道这是什么语言，所以不需要注释语句功能，尽量使用简短而有描述力的注释。

Java有两种类型的注释：

//This is a comment that continues until the end of the line.

/* This is a comment. It goes on and on and on and on and on and on and on

and on and on and on and on and on and on and on and on and on and on and

on and on and on and on and on and on and on and on and ends like this: */

/**

* This is a JavaDoc comment. More about JavaDoc in the next section.

*/

如果在注释中加入注释则会出错：

/* You are not allowed to do anything like this /* because the compiler will

complain, if you are lucky */ DON'T DO THIS! And don't write comments in

upper case either... */

注释应放在它要解释内容上下，这样会让代码更易于理解。

不要注释一些语言的语句功能：

i++; // Add 1 to i

更不要让自己的代码处于这种状态：

for(int i = 1; i = n; i++)

/* don't place comments where

they don't belong */

result*=i;

较短的注释既可被放在被注释代码上下，而长注释则习惯性的放在代码之上：

/* Comments can be placed before the

block that is to be commented */

for(int i = 1; i = n; i++)

result*=i;

或者:

for(int i = 1; i = n; i++){

result*=i; // short comments can be placed like this

tmp++; // if necessary, they continue here

}

不要写没用的注释：

i++; // change this later

Excuse me,这句肯定是胡扯！

不要写自己都看不懂的注释：

i++; // BMW

BMW? 如果你能连续十天记住这是什么意思的话，那么你的记忆真是不错了。所以不要写没人能看懂的注释，ok高手代码风格java？

最后重申一下：写简短而富于描述性的注释，把它们放在该放的地方，而不要考验你自己的记忆力！

JavaDoc - 文档工具

JavaDoc不仅是另一种给代码加注释的仿佛咱，更是一个文档工具。类、方法和一些重要地方需要用JavaDoc来注释。这并不是说你可以放弃常规的注释，这两者在代码中应该是相辅相成、互相弥补的关系。

类被注释如：

/**

* Car represents cars ... A description of the class

* should be place here. Note that the description begins

* on the second line and that there is a space between

* the asterix and the text. Next we will add some fields

* indicating who the authors of the class are and

* other useful information. Notice the newline!

*

* @author Jerry Meng

* @version %I%, %G%

*/

public class Car {

注意JavaDoc结束和类开始间无空行。

方法被注释如：

/**

* A description of what the method does...

*

* @param n a description of the parameter

* @return a description of the return value

*/

public int factorial(int n) {

某些不是全部，被JavaDoc注释区域如：

/**

* Short description of the variable (one line)

*/

type variable;

什么应当使用JavaDoc做注释高手代码风格java？如何注释的恰当呢？

可以这样想，JavaDoc中所作的注释都可以在类的文档中看到。所有读这个类的文档的读者都会明白这个类所完成的功能、它包括的方法、如何使用这些方法及方法的返回值。一些作用域，比如public的变量或常量将会一目了然。任何不了解这个类内部结构的人都可以轻松的调用它。这便是你用JavaDoc可以轻松提供的信息。而使用一般注释的地方，一般是给那些可能修改你的类代码的程序员，它们一般描述了类的内部信息和结构。

下面我写一下car的类来描述一个编程风格好的java类应该是怎样的。当然这仅仅是一个小例子(apart from selector and mutator methods)，仅仅是在考虑JAVA编程风格上一个参考而已。

import java.awt.Color;

/**

* This is a class representing cars. A car has certain features, such

* as color, age, number of doors etc and a car can be repainted,

* the tank can be filled etc.

*

* @author Jerry Meng

* @version %I%, %G%

*/

public class Car {

/**

* The maximum size of the tank in litres.

*/

private static final double TANK_SIZE = 100.0;

/**

* The color of the car.

*/

private Color color;

/**

* The age of the car.

*/

private int age;

/**

* The number of doors of the car.

*/

private int doors;

/**

* The amount of gasoline in the tank.

*/

private double gasoline;

/**

* Class constructor, which constructs a brand new, black car with

* five doors and a full tank.

*/

public Car() {

this(Color.black, 0, 5, TANK_SIZE);

}

/**

* Class constructor specifying the color, age, number of doors

* and litres of gasoline

*

* @param color The color of the car

* @param age The age of the car

* @param doors The number of doors

* @param km Kilometres driven

* @param gasoline The litres of gasoline

*/

public Car(Color color, int age, int doors, double gasoline) {

this.color = color;

this.age = age;

this.doors = doors;

this.gasoline = gasoline;

}

/**

* Returns the color of the car

*/

public Color getColor() {

return color;

}

/**

* Repaints the car (i.e. changes its color)

*/

public void setColor(Color color) {

this.color = color;

}

/**

* Returns the age of the car

*/

public int getAge() {

return age;

}

/**

* Returns the number of doors of the car

*/

public int getDoors() {

return doors;

}

/**

* Returns the amount of gasoline in the tank

*/

public double getGasoline() {

return gasoline;

}

/**

* Fills the tank. The amount of gasoline cannot exceed

* the size of the tank. In that case, the tank will be

* filled to the maximum and the rest will run out in

* the sand.

*

* @param gas The amount of gasoline to put in the tank

*/

public void setGasoline(double gas) {

if(gasoline + gas = TANK_SIZE)

gasoline+=gas;

else

gasoline = TANK_SIZE;

}

}

高手代码风格java的介绍就聊到这里吧，感谢你花时间阅读本站内容，更多关于代码编程java、高手代码风格java的信息别忘了在本站进行查找喔。