diff --git a/项目命名/项目命名格式.md b/项目命名/项目命名格式.md index 321d435..1bb4bfe 100644 --- a/项目命名/项目命名格式.md +++ b/项目命名/项目命名格式.md @@ -272,7 +272,9 @@ getMessageById(id) 1 2 Advance with the time 注解应该随着代码的变动而改变,注解表达的信息要与代码中完全一致。通常情况下修改代码后一定要修改注解。 + #### 6.2 注解格式 + 注解大体上可以分为两种,一种是 javadoc 注解,另一种是简单注解。javadoc 注解可以生成 JavaAPI 为外部用户提供有效的支持 javadoc 注解通常在使用 IDEA,或者 Eclipse 等开发工具时都可以自动生成,也支持自定义的注解模板,仅需要对对应的字段进行解释。参与同一项目开发的同学,尽量设置成相同的注解模板。 a. 包注解