注释怎么写

 自己记录一下。

位置	内容	tips
类和接口	/ ** *〈一句话功能简述〉 *〈功能详细描述〉 * * @author  * @since */	描述部分的第一行应该是一句对类、接口、方法等的简单描述，这句话最后会被javadoc工具提取并放在索引目录中。
公有和保护方法	/ ** *〈一句话功能简述〉 *〈功能详细描述〉 * * @param [参数1] [说明] * @param [参数2] [说明] * @return [返回类型说明] * @throws [异常] [说明] * @deprecated */	方法的注释应该以动词或动词词组开头，因为方法是一个动作 当描述类、接口、方法这类的概念时，可以不用指名"类"、"接口"、"方法"(相当于废话) 对于方法内部用throw语句抛出的异常，必须在方法的注释中标明，对于所调用的其他方法所抛出的异常，选择主要的在注释中说明。 对参数的特殊要求或有参数需要解释
方法内部： 分支语句 tricky的技巧 特殊的业务逻辑 TODO 需要警示的坑 有关pipeline的写一下steps或贴一下设计文档	//对代码的注释应放在其上方或右方	不要去注释“我的代码做了什么？”，而是要注释“我的代码为什么要这么做？”（从废话到注释）代码只会告诉你“这样实现”，而不会告诉你“为什么要这样实现”。就是当你觉得一个注释是废话的时候，它只是在翻译这段代码在做什么，程序员一般更喜欢直接读代码找答案（这也是说为啥这也是说为啥好的代码不需要注释，因为函数的命名承担了解释这个功能）。而真正有用的注释是在别人读你代码的时候，费解这里为什么要这么写而你刚好在代码上面解释了你的意图。