A.成员变量注释内容:成员变量的意义、目的、功能,可能被用到的地方。
B.公有和保护方法注释内容:列出方法的一句话功能简述、功能详细描述、作者、输入参数、输出参数、返回值、违例等。
C.类和接口的注释内容:类的注释主要是一句话功能简述、功能详细描述,可根据需要列出:版本号、生成日期、作者、内容、功能、与其它类的关系等。 如果一个类存在Bug,请如实说明这些Bug。
D.文件注释内容有:文件名、版权说明、描述信息、生成日期、修改历史。
E.包的注释内容:简述本包的作用、详细描述本包的内容、产品模块名称和版本、公司版权。