From af924d4a3549658099b0591d9b46528f0db814be Mon Sep 17 00:00:00 2001 From: adiao <1819192616@qq.com> Date: Sun, 9 Apr 2023 05:18:33 +0800 Subject: [PATCH] Updated files --- 项目命名/项目命名格式.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/项目命名/项目命名格式.md b/项目命名/项目命名格式.md index ca55c28..94b6f67 100644 --- a/项目命名/项目命名格式.md +++ b/项目命名/项目命名格式.md @@ -267,9 +267,12 @@ public class HelloWorld { Nothing is strange 没有注解的代码对于阅读者非常不友好,哪怕代码写的在清除,阅读者至少从心理上会有抵触,更何况代码中往往有许多复杂的逻辑,所以一定要写注解,不仅要记录代码的逻辑,还有说清楚修改的逻辑。 Less is more 从代码维护角度来讲,代码中的注解一定是精华中的精华。合理清晰的命名能让代码易于理解,对于逻辑简单且命名规范,能够清楚表达代码功能的代码不需要注解。滥用注解会增加额外的负担,更何况大部分都是废话。 + +``` // 根据id获取信息【废话注解】 getMessageById(id) ``` + 1. Advance with the time 注解应该随着代码的变动而改变,注解表达的信息要与代码中完全一致。通常情况下修改代码后一定要修改注解。 #### 6.2 注解格式