├── LICENSE
├── README.md
├── 代码审查避雷指南
    └── 新人code review典型问题.md
└── 命名指南大全
    └── 给函数起个好名字—动词选择.md


/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2022 gscheartA
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Improve-your-code
2 | 《改善丑陋的代码》——红桃A士视频分享系列
3 | 


--------------------------------------------------------------------------------
/代码审查避雷指南/新人code review典型问题.md:
--------------------------------------------------------------------------------
  1 | # 如何避免被code review毒打，总结cr中的典型问题
  2 | <br><br><br>
  3 | 
  4 | # 1 命名不规范
  5 | <br>
  6 | 
  7 | ## 典型问题：
  8 | ### 1.取名过于简单，无法清晰表达含义
  9 | ```
 10 | //单字符,简短单词作为变量名
 11 | bool flag = false;
 12 | for(f in markedFiles){
 13 |     //handle each marked file
 14 | }
 15 | ```
 16 | ### 2.命名风格不一，影响代码阅读
 17 | ```
 18 | //多种风格的方法名
 19 | IsProcessRunning()
 20 | CheckIfPageClosed()
 21 | ```
 22 | ### 3.没参照规范命名
 23 | <br>
 24 | 
 25 | ## 建议：
 26 | ### 1.遵循已有的命名规范：
 27 | ### -若公司/团队对于命名有规范文档，应好好研究。
 28 | ### -可以适当参照现有代码的命名风格。
 29 | ### 2.命名要能够清晰展现有关的含义(好的命名的基本要求)
 30 | ### -较长而清晰的命名优于简短而模糊的命名，不要过于追求简短。
 31 | ### -为一个好的命名花费的思考是值得的。
 32 | ### 3.命名技巧学习：
 33 | ### -多阅读书籍、教程、知名源码等等，学习命名思路和技巧。
 34 | 
 35 | <br>
 36 | 
 37 | # 2 注释不合规
 38 | <br>
 39 | 
 40 | ## 典型问题：
 41 | ### 1.修改代码不更新注释,造成误导
 42 | ```
 43 | //do something about A 
 44 | Function()
 45 | {
 46 |     // do some actions about B
 47 | }
 48 | ```
 49 | ### 2.无意义的注释(如日志型日志,废弃的代码)
 50 | ```
 51 | /*
 52 |  * Date: 1 Jan
 53 |  * Author: Hongtao
 54 |  * Change: Update this function for fixing bug : ...
 55 |  * ........
 56 | */
 57 | Function(){
 58 |     /*
 59 |     OldFlow();
 60 |     */
 61 |     NewFlow();
 62 | }
 63 | ```
 64 | ### 3.过多篇幅的注释
 65 | ```
 66 | /*
 67 |     multi-lines
 68 | */
 69 | Function(){
 70 |     ......
 71 | }
 72 | ```
 73 | <br>
 74 | 
 75 | ## 建议：
 76 | ### 1.遵循已有的注释规范：
 77 | ### -若公司/团队对于命名有规范文档，应好好研究。
 78 | ### -可以适当参照现有代码的注释风格。
 79 | ### 2.避免写出坏注释：
 80 | ### -不达意的注释
 81 | ### -含有误导的注释
 82 | ### -与逻辑无关的注释
 83 | ### 3.及时更新注释
 84 | ### 4.清晰的代码是不需要太多注释说明的
 85 | <br>
 86 | 
 87 | # 3 函数封装和复用
 88 | <br>
 89 | 
 90 | ## 典型问题：
 91 | ### 1.不使用公司/团队封装的工具库，自己重新实现
 92 | ```
 93 | //文件IO工具类的封装
 94 | class FileUtility{
 95 |     Read(){}
 96 |     Write(){}
 97 |     Copy(){}
 98 |     Delete(){}
 99 |     ...
100 | }
101 | //字符串格式处理工具类的封装
102 | class StringUtility(){
103 |     EncodeString()
104 |     DecodeString()
105 |     Foramt()
106 |     ToUpper()
107 |     ToLower()
108 |     ...
109 | }
110 | ```
111 | ### 2.函数过长，缺乏提炼
112 | ```
113 | Function()
114 | {
115 |     // do A
116 |     ...
117 |     // do B
118 |     ...
119 |     // do C
120 |     ...
121 |     ...
122 | }
123 | ```
124 | ### 3.重复代码不做复用
125 | <br>
126 | ## 建议：
127 | ### 1.底层逻辑编码时，先看看是否被公司/团队进行过封装。
128 | ### -字符串等数据结构的处理
129 | ### -文件、日期等类型的处理
130 | ### -异步操作，事件绑定等处理
131 | ### 2.按照职责设计和提炼函数,尽量做到函数单一职责
132 | ### 3.相同逻辑的代码积极复用
133 | <br>
134 | # 4 不合理的变量定义
135 | <br>
136 | 
137 | ## 典型问题：
138 | ### 1.变量定义不考虑解耦
139 | ```
140 | //方法体中的整型/字符串定义
141 | class WebpageLauncher(){
142 |     public int LaunchLoginPage(){
143 |         string loginUrl = "www.xxx.com/login"
144 |         ......
145 |         if(error){
146 |             return 1001;
147 |         }
148 |     }
149 |     public LaunchHelpPage(){
150 |         string helpUrl = "www.xxx.com/help"
151 |         ......
152 |         if(error){
153 |             return 1002;
154 |         }
155 |     }
156 | }
157 | ```
158 | ### 2.使用常量代替应该动态生成的内容
159 | ```
160 | const string systemPath = "C:\\";
161 | ```
162 | <br>
163 | 
164 | ## 建议：
165 | ### 1.使用字面量定义时，考虑能否解耦
166 | ### -类中使用的常量，可以定义为类中的静态常量
167 | ### -全局使用的常量，通常被集中定义在某些文件中(config、table、global)。
168 | ### 2.能够在运行时获取的内容(系统API、网络、文件)，不应被定义在代码中。
169 | <br><br><br><br>
170 | 
171 | 
172 | 


--------------------------------------------------------------------------------
/命名指南大全/给函数起个好名字—动词选择.md:
--------------------------------------------------------------------------------
  1 | # 函数中的动词选取
  2 | <br>
  3 | 
  4 | # 选取原则1 避免滥用通用单词
  5 | 
  6 | ## 案例1：万能的Get
  7 | ## GetTotalAmount();
  8 | ### 获取属性?
  9 | ### 获取本地存储内容?
 10 | ### 获取网络内容?
 11 | ### 获取数据库内容?
 12 | ### 获取计算后的内容?
 13 | ### ......
 14 | <br>
 15 | 
 16 | ## 案例2：万能的Add
 17 | ## AddCharacter();
 18 | ### 添加到头部?
 19 | ### 添加到尾部?
 20 | ### 从中间插入字符?
 21 | ## ......
 22 | <br>
 23 | 
 24 | ## 问题：
 25 | ### 通用单词可以在很多场景下命名，但不能区分具体函数职责。
 26 | ### 当函数本身的实现途径不同时，难以从函数名得到足够的信息。
 27 | <br>
 28 | 
 29 | # 函数命名动词大全指南：
 30 | 
 31 | 
 32 | ## 创建/销毁
 33 | <table class="table table-bordered table-striped table-condensed">
 34 |    <tr>
 35 |       <th>动词</th>
 36 |       <th>用途</th>
 37 |       <th>示例</th>
 38 |    </tr>
 39 |    <tr>
 40 |       <td>Create</td>
 41 |       <td>创建实例，常用于实例化方法和工厂方法的命名</td>
 42 |       <td>CreateInstance</td>
 43 |    </tr>
 44 |    <tr>
 45 |       <td>Initialize</td>
 46 |       <td>初始化实例的属性和设置，Initialize本身也可作为类方法用来初始化</td>
 47 |       <td>InitializeInstance,Initialize</td>
 48 |    </tr>
 49 |    <tr>
 50 |       <td>Load</td>
 51 |       <td>加载配置，根据配置创建内容</td>
 52 |       <td>LoadFromConfig</td>
 53 |    </tr>
 54 |    <tr>
 55 |       <td>Destroy</td>
 56 |       <td>销毁实例，常用语析构方法</td>
 57 |       <td>DestroyInstance</td>
 58 |    </tr>
 59 |    <tr>
 60 |       <td>Uninitialize</td>
 61 |       <td>清理实例的属性和设置，通常和Initialize对应</td>
 62 |       <td>UninitializeInstance,Uninitialize</td>
 63 |    </tr>
 64 | </table>
 65 | <br>
 66 | 
 67 | ## 获取/设置
 68 | <table class="table table-bordered table-striped table-condensed">
 69 |    <tr>
 70 |       <th>动词</th>
 71 |       <th>用途</th>
 72 |       <th>示例</th>
 73 |    </tr>
 74 |    <tr>
 75 |       <td>Get</td>
 76 |       <td>常用于取属性的类方法命名，也可作为通用获取方法命名</td>
 77 |       <td>GetStartTime</td>
 78 |    </tr>
 79 |    <tr>
 80 |       <td>Fetch</td>
 81 |       <td>通过网络请求获取内容</td>
 82 |       <td>FetchAllUsers</td>
 83 |    </tr>
 84 |    <tr>
 85 |       <td>Calculate</td>
 86 |       <td>通过计算获取内容</td>
 87 |       <td>CalculateTotalAmount</td>
 88 |    </tr>
 89 |    <tr>
 90 |       <td>Read</td>
 91 |       <td>读取(多用于文件，配置等)</td>
 92 |       <td>ReadFile,ReadConfig</td>
 93 |    </tr>
 94 |    <tr>
 95 |       <td>Query</td>
 96 |       <td>查询</td>
 97 |       <td>QueryRemainingAmount</td>
 98 |    </tr>
 99 |    <tr>
100 |       <td>Find</td>
101 |       <td>查找(多用于数据库，集合等),和search相似</td>
102 |       <td>FindOrder</td>
103 |    <tr>
104 |       <td>Receive</td>
105 |       <td>接收(多用于文件，消息等)</td>
106 |       <td>ReceiveNewMessage</td>
107 |    </tr>
108 |    <tr>
109 |       <td>Pull</td>
110 |       <td>拉取</td>
111 |       <td>PullLastestSourceCode</td>
112 |    </tr>
113 |       <tr>
114 |       <td>Set</td>
115 |       <td>常用于设置属性的类方法命名，也可作为通用设置方法命名</td>
116 |       <td>SetStartTime</td>
117 |    </tr>
118 |    <tr>
119 |       <td>Write</td>
120 |       <td>写入(文件/配置等)</td>
121 |       <td>WriteFile,WriteConfig</td>
122 |    </tr>
123 |    <tr>
124 |       <td>Put</td>
125 |       <td>放入</td>
126 |       <td>PutUserWithId</td>
127 |    </tr>
128 |    <tr>
129 |       <td>Push</td>
130 |       <td>存入,推送(通知)</td>
131 |       <td>PushNotification</td>
132 |    </tr>
133 | </table>
134 | <br>
135 | 
136 | ## 更新
137 | <table class="table table-bordered table-striped table-condensed">
138 |    <tr>
139 |       <th>动词</th>
140 |       <th>用途</th>
141 |       <th>示例</th>
142 |    </tr>
143 |    <tr>
144 |       <td>Reset</td>
145 |       <td>强调重置(标记,状态)</td>
146 |       <td>ResetTimer</td>
147 |    </tr>
148 |    <tr>
149 |       <td>Refresh</td>
150 |       <td>用于命名刷新(多用于页面,缓存等)</td>
151 |       <td>RefreshCurrentPage</td>
152 |    </tr>
153 |    <tr>
154 |       <td>Update</td>
155 |       <td>更新(多用于配置，状态等)</td>
156 |       <td>UpdateUserSetting</td>
157 |    </tr>
158 | </table>
159 | <br>
160 | 
161 | ## 添加/移除
162 | <table class="table table-bordered table-striped table-condensed">
163 |    <tr>
164 |       <th>动词</th>
165 |       <th>用途</th>
166 |       <th>示例</th>
167 |    </tr>
168 |    <tr>
169 |       <td>Add</td>
170 |       <td>用于通用添加方法命名</td>
171 |       <td>AddNewStudent</td>
172 |    </tr>
173 |    <tr>
174 |       <td>Append</td>
175 |       <td>强调在尾部添加(追加)</td>
176 |       <td>AppendCharacter</td>
177 |    </tr>
178 |    <tr>
179 |       <td>Insert</td>
180 |       <td>强调插入(可以在任意位置)</td>
181 |       <td>InsertCharacter</td>
182 |    </tr>
183 |    <tr>
184 |       <td>Delete</td>
185 |       <td>表示删除,和Remove相近</td>
186 |       <td>DeleteDirectory</td>
187 |    </tr>
188 |    <tr>
189 |       <td>Remove</td>
190 |       <td>表示移除,和Delete相近</td>
191 |       <td>RemoveInvalidDeals</td>
192 |    </tr>
193 | </table>
194 | <br>
195 | 
196 | ## 启动/停止
197 | <table class="table table-bordered table-striped table-condensed">
198 |    <tr>
199 |       <th>动词</th>
200 |       <th>用途</th>
201 |       <th>示例</th>
202 |    </tr>
203 |    <tr>
204 |       <td>Open</td>
205 |       <td>开启(多用于开启状态,打开文件等)</td>
206 |       <td>OpenEnhanceMode</td>
207 |    </tr>
208 |    <tr>
209 |       <td>Start</td>
210 |       <td>开始(强调开始某个流程)</td>
211 |       <td>StartPortListening</td>
212 |    </tr>
213 |    <tr>
214 |       <td>Launch</td>
215 |       <td>发动/启动(多用于启动程序,服务)</td>
216 |       <td>LaunchAssistService</td>
217 |    </tr>
218 |    <tr>
219 |       <td>Close</td>
220 |       <td>关闭(多用于关闭状态,关闭文件等)</td>
221 |       <td>CloseEnhanceMode</td>
222 |    </tr>
223 |    <tr>
224 |       <td>Stop</td>
225 |       <td>停止(强调流程的终止)</td>
226 |       <td>StopPortListening</td>
227 |    </tr>
228 |    <tr>
229 |       <td>Pause</td>
230 |       <td>暂停(强调流程的暂停，有可能后续会继续开启)</td>
231 |       <td>PausePageLoading</td>
232 |    </tr>
233 |    <tr>
234 |       <td>Finish</td>
235 |       <td>完成(强调流程的完成)</td>
236 |       <td>FinishRequesting</td>
237 |    </tr>
238 | </table>
239 | <br>
240 | 
241 | ## 集合类型相关数据处理
242 | <table class="table table-bordered table-striped table-condensed">
243 |    <tr>
244 |       <th>动词</th>
245 |       <th>用途</th>
246 |       <th>示例</th>
247 |    </tr>
248 |    <tr>
249 |       <td>Filter</td>
250 |       <td>过滤,筛选(强调按照某些条件)</td>
251 |       <td>FilterByName</td>
252 |    </tr>
253 |    <tr>
254 |       <td>Merge</td>
255 |       <td>合并(有时会带上合并规则)</td>
256 |       <td>MergeTwoConfig</td>
257 |    </tr>
258 |    <tr>
259 |       <td>Concat</td>
260 |       <td>拼接(直接在结尾添加)</td>
261 |       <td>ConcatToArray</td>
262 |    </tr>
263 |    <tr>
264 |       <td>Split</td>
265 |       <td>分割</td>
266 |       <td>SplitInput</td>
267 |    </tr>
268 |    <tr>
269 |       <td>Deduplicate</td>
270 |       <td>去重(去重完全相同的项)</td>
271 |       <td>DeduplicateList</td>
272 |    </tr>
273 |    <tr>
274 |       <td>Reverse</td>
275 |       <td>颠倒,反向排列</td>
276 |       <td>ReverseRecord</td>
277 |    </tr>
278 |    <tr>
279 |       <td>Sort</td>
280 |       <td>排序(有时会带上排序规则)</td>
281 |       <td>SortDealsByAmount</td>
282 |    </tr>
283 |    <tr>
284 |       <td>Fill</td>
285 |       <td>填充(一般会进行覆盖)</td>
286 |       <td>FillAmountList</td>
287 |    </tr>
288 | </table>
289 | <br>
290 | 
291 | ## 通用业务数据处理
292 | <table class="table table-bordered table-striped table-condensed">
293 |    <tr>
294 |       <th>动词</th>
295 |       <th>用途</th>
296 |       <th>示例</th>
297 |    </tr>
298 |    <tr>
299 |       <td>Parse</td>
300 |       <td>解析(解析成某些格式,解析提取某些内容)</td>
301 |       <td>ParseFromJson,ParseResult</td>
302 |    </tr>
303 |    <tr>
304 |       <td>Analyse</td>
305 |       <td>分析(不一定能通过简单的方式获取)</td>
306 |       <td>AnalyseLocation</td>
307 |    </tr>
308 |    <tr>
309 |       <td>Convert</td>
310 |       <td>类型转换(通常用于从一个类型转换到另一种类型)</td>
311 |       <td>ConvertToString</td>
312 |    </tr>
313 |    <tr>
314 |       <td>Format</td>
315 |       <td>格式化数据</td>
316 |       <td>FormatToLocaleString</td>
317 |    </tr>
318 |    <tr>
319 |       <td>Validate</td>
320 |       <td>合法性/有效性的校验</td>
321 |       <td>ValidateUserInputs</td>
322 |    </tr>
323 |    <tr>
324 |       <td>Ensure</td>
325 |       <td>期待值的校验</td>
326 |       <td>EnsureUserAge</td>
327 |    </tr>
328 |    <tr>
329 |       <td>Compose</td>
330 |       <td>组成(一般由多项内容组成一个结果)</td>
331 |       <td>ComposeMessage</td>
332 |    </tr>
333 |    <tr>
334 |       <td>Encode</td>
335 |       <td>编码(依赖约定的编码格式)</td>
336 |       <td>EncodeUrl</td>
337 |    </tr>
338 |    <tr>
339 |       <td>Decode</td>
340 |       <td>解码(依赖约定的解码格式)</td>
341 |       <td>DecodeUrl</td>
342 |    </tr>
343 |    <tr>
344 |       <td>Encrypt</td>
345 |       <td>数据加密(依赖约定的加密算法)</td>
346 |       <td>EncryptContent</td>
347 |    </tr>
348 |    <tr>
349 |       <td>Decrypt</td>
350 |       <td>数据解密(依赖约定的解密算法)</td>
351 |       <td>DecryptContent</td>
352 |    </tr>
353 |    <tr>
354 |       <td>Backup</td>
355 |       <td>备份(需要注意拷贝方式，避免误导)</td>
356 |       <td>BackupUserSettings</td>
357 |    </tr>
358 |    <tr>
359 |       <td>Restore</td>
360 |       <td>恢复</td>
361 |       <td>RestoreUserSettings</td>
362 |    </tr>
363 |    <tr>
364 |       <td>Import</td>
365 |       <td>导入(通常用于按照特定格式的文件转换)</td>
366 |       <td>ImportFromFile</td>
367 |    </tr>
368 |    <tr>
369 |       <td>Export</td>
370 |       <td>导出(通常用于转换成特定格式的文件)</td>
371 |       <td>ExportToFile</td>
372 |    </tr>
373 |       <tr>
374 |       <td>Compress</td>
375 |       <td>压缩(依赖约定的算法)</td>
376 |       <td>CompressOversizedFile</td>
377 |    </tr>
378 |    <tr>
379 |       <td>Decompress</td>
380 |       <td>解压缩(依赖约定的算法)</td>
381 |       <td>DecompressOversizedFile</td>
382 |    </tr>
383 | </table>
384 | <br>
385 | 


--------------------------------------------------------------------------------