Java代码开发----针对函数的注释

在Java开发中，为方便使用，会定义各种函数，但如果没有对函数进行相关的说明，则过一段时间，自己会忘记这个函数的具体功能或者说参数的含义，不方便后面的代码维护，故在必要的函数的开头，加上一段详细的注释是非常有必要的。
在擦看他人的代码的过程中，发现了一种比较好的注释格式（或者说是大家都默认的格式，只是自己不知道，没有对应的习惯），为此，在这里记录下来，方便提醒自己，养成良好的代码习惯。

//Java函数注释

/**
*根据ID获取对象
* @param id  对象ID
* @return  返回的是一个对象
* @author  ccy 
*/
public Thing getSomething(String id){
}

更多相关的注释，见 Java 文档注释