Java开发前的准备——注释

Java开发前的准备——注释

什么是注释：注释就是对代码的解释和说明，其目的是让人们能够更加轻松地了解代码。（注释是给开发人员看的）
好的代码和注释比例：30%代码+70%注释。
注意：注释很重要，但是并不代表注释可以美化糟糕的代码，甚至有些不好的注释会丑化代码。
通过下面两段代码可以得出以上结论

//Check to see if the employee is eligible for full benefits
if((employee,flags & HOURLY_FLAG) && (employee.age > 65))

----------------------------------美丽的分割线-----------------------------------------

if(employee.isEligibleForFullBenefits())

我们不难分辨其中哪段代码更具有可读性。当然还有更可怕的“废话”注释：

/** The name */
private String name;
/** The sex */
private char sex;
/** The age */
private int age;
/** The version */
private String info;

见到了如上的一些不好的注释示范，那么什么注释是真正好的注释呢？

法律信息：版权及著作权声明式必须和有理由在每个源文件开头注释处放置的内容。例如：// CopyRight (C) 2019 by yufeng , All Rights Reserved.

提供信息的注释：提供基本信息。例如// Returns an instance of the Responder being tested.来注释解释了某个抽象方法的返回值。

阐释：将一些晦涩的参数或者返回值的意义翻译为更好理解的形式。例如：assertTrue(a.compareTo(a) == 0) // a==a

警示：用于警告其他程序员会出现某种后果的注释。例如：// SimpleDateFormat is not safe.

TODO注释：用//TODO形式在源代码中放置要做的工作列表。例如：// We expect this to go away when we do the checkout model.

总的来说，注释的作用是帮助大家读懂代码、维护代码。那么在java中如何书写注释呢？
在Java中的注释分为三种：文档注释、单行注释、多行注释。

/** 文档注释 */

//单行注释

/*
* 多行注释
* 多行注释
*/

以上便是关于Java注释中的内容了。同时推荐一本书《代码整洁之道》，本文章中的大多代码和介绍皆是借鉴此书写成，颇有裨益。