Clean Code 笔记 之 第四章 如何应用注释
继上一篇笔记之后,今天我们讨论一下 代码中是存在注释是否是一件好的事情。
在我们开发的过程中讲究“名副其实,见名识意”,这也往往是很多公司的要求,但是有了这些要求是不是我们的代码中如果存在注释是不是意味着我们的 函数,变量,以及类 的命名就不符合了“名副其实,见名识意”。
我们先区分一下注释的类别,注释一般分为以下几种:
- 1, 单行注释
- 2, 多行注释
- 3, 文档注释
- 4, #region 折叠注释,可以将 代码折叠
注释的类别
1, 单行注释:
在以 “//” 开头,用以说明一行代码的作用放置位置 看习惯或者公司要求合理就行。常用于函数内部,在很多的开源代码中文件的头部我同样见到很多人使用单行注释进行说明,灵活就好。
体现形式如下:
public List<string> getVipUserNameByUserType() { // Vip user name list var vipUserNames = new List<string>(); foreach (var user in Users) { if (user.Type = "VIP") vipUserNames.Add(user.Name); } return vipUserNames; }
2, 多行注释:
以“/*”开头 “*/” 结尾 常用于描述说明一段代码以及类注释或者说代码块常用于文件的顶部。说明作者信息,时间如果是开源的这包含开源的更多说明。
通常使用如下:
/* * 作者:〈版权〉 * 描述:〈描述〉 * 创建时间:YYYY-MM-DD * 作用: */
3, 文档注释:
也就是常用的XML 注释:它的说明性更加的强烈,多用于类以及函数上,当然属性上同样可以使用:
如下所示:
/// <summary> /// MyClass /// </summary> public class MyClass { /// <summary> /// MyProperty /// </summary> public int MyProperty { get; set; } /// <summary> /// MyMethod /// </summary> public void MyMethod(){ } }
以下是官方建议的文档标记 点击标签会制动跳转
4, #region : 折叠注释,常用于描述多个函数的基本作用
书中最喜欢的话
好的注释不能美化糟糕的代码,真正好的注释是你想尽办法不去谢的注释。怀注释都是糟糕代码的支撑或借口,或者是对错误决策的修正。
下面看一个例子
//Check to see if the employee is eligible for full benefits ()If((employee.flags & HOURLY_FLAG)&& (employee.age>)) ()If(employee.isEligibleForFullBenefits())) 这两个你更喜欢哪个
好的注释的特征:
1:表示法律信息(这样的注释一般出现在文档顶部说明作用以及协议)
// Copyright (c) .NET Foundation. All rights reserved // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
2:提供信息的注释(指无法通过命名提供信息如要 注释辅助的)
public void ConfigureServices(IServiceCollection services) { // These two middleware are registered via an IStartupFilter in UseIISIntegration but you can configure them here. services.Configure<IISOptions>(options => {}); }
3:对意图的解释
4: 警示:告知其他人会出现某种后果的注释
5: TODO注释: 主要描述应该做的目前还没有做的事情。
6: 放大:提示不合理之物的重要性。
应避免的注释
应该避免以下几点:
1: 误导性注释
2: 日志式注释
3: 废话注释
4: 标记位置的注释
5: 括号后的注释
6: 归属与签名
7: 注释掉的代码
8: Html 注释
以上没有一一举例的原因是我的PPT是一份演示的PPT,里面很多公司的代码不便贴出,抱歉。
不足之处还请指出
Clean Code 笔记 之 第四章 如何应用注释的更多相关文章
- 【NPDP笔记】第四章 文化组织与团队
此为临时链接,仅用于预览,将在短期内失效.关闭 [NPDP笔记]第四章 文化组织与团队 小康 小康哥的产品之路 9月6日 4.1 文化和氛围对创新的重要性 文化:信念,价值观,假设,与期望 氛围:直接 ...
- Introduction to 3D Game Programming with DirectX 12 学习笔记之 --- 第四章:Direct 3D初始化
原文:Introduction to 3D Game Programming with DirectX 12 学习笔记之 --- 第四章:Direct 3D初始化 学习目标 对Direct 3D编程在 ...
- Clean Code 笔记 之 第二章
你是否真正的会命名 前言 这是我第二次看这本书了(Clean Code)的时候,第一次看的时候是,看到某世界五百强在他们的代码中我竟然看不到一句注释,现在我还记得当时的情景,当我Download 下第 ...
- 代码整洁之道Clean Code笔记
@ 目录 第 1 章 Clean Code 整洁代码(3星) ?为什么要整洁的代码 ?什么叫做整洁代码 第 2 章 Meaningful Names 有意义的命名(3星) 第 3 章 Function ...
- win32多线程程序设计笔记(第四章下)
上一笔记讲了同步机制中的临界区域(Critical Sections).互斥器(Mutexes),下面介绍同步机制中的另外两种. 信号量(Semaphores) 举个例子: 现在有人要租车,接待他的代 ...
- 05 技术内幕 T-SQL 查询读书笔记(第四章)
第四章 子查询:在外部查询内嵌套的内部查询(按照期望值的数量分为,标量子查询 scalar subqueries,多值子查询multivalued subqueries)(按照子查询对外部查询的依赖性 ...
- Linux内核分析 读书笔记 (第四章)
第四章 进程调度 调度程序负责决定将哪个进程投入运行,何时运行以及运行多长时间.进程调度程序可看做在可运行态进程之间分配有限的处理器时间资源的内核子系统.只有通过调度程序的合理调度,系统资源才能最大限 ...
- 《深入理解java虚拟机》读书笔记三——第四章
第四章 虚拟机性能监控与故障处理工具 1.JDK命令行工具 jps命令: 作用:列出正在运行的虚拟机进程. 格式:jps [option] [hostid] 选项:-q 只输出LVMID(Local ...
- 《机器学习实战》学习笔记第十四章 —— 利用SVD简化数据
相关博客: 吴恩达机器学习笔记(八) —— 降维与主成分分析法(PCA) <机器学习实战>学习笔记第十三章 —— 利用PCA来简化数据 奇异值分解(SVD)原理与在降维中的应用 机器学习( ...
随机推荐
- ElasticSearch - ElasticSearch和kinaba的简单使用
ElasticSearch和kinaba的简单使用 ElasticSeatch 文档推荐 ElasticSearch 下载 (端口 9200) 安装好es,可以访问 http://localhost: ...
- PhpStorm10和Apache24配置多项目开发环境
PhpStorm10和Apache24配置多项目开发环境 Apache配置 httpd.conf LoadModule vhost_alias_module modules/mod_vhost_ali ...
- 面向对象之---this的用法
在绝大多数情况下,函数的调用方式决定了this的值 全局环境 无论是否在严格模式下,在全局执行环境中,this都指向全局对象· 在全局作用域中调用一个函数时,this总是指向Global对象(在浏览器 ...
- 用Unity做游戏,你需要深入了解一下IL2CPP
这次我们翻译了一篇Unity官方博客上的文章,原文题目为AN INTRODUCTION TO IL2CPP INTERNALS ,作者是从事Unity软件开发的Joshua Peterson.文章的看 ...
- Netty 入门,这一篇文章就够了
Netty是Java领域有名的开源网络库,特点是高性能和高扩展性,因此很多流行的框架都是基于它来构建的,比如我们熟知的Dubbo.Rocketmq.Hadoop等,针对高性能RPC,一般都是基于Net ...
- 为什么磁盘慢会导致Linux负载飙升?
一.CPU利用率和负载率的区别 这里要区别CPU负载和CPU利用率,它们是不同的两个概念,但它们的信息可以在同一个top命令中进行显示.CPU利用率显示的是程序在运行期间实时占用的CPU百分比,这是对 ...
- 使用msfvenom生成木马
msfvenom Options: -p, --payload < payload> 指定需要使用的payload(攻击荷载).如果需要使用自定义的payload,请使用& #03 ...
- [考试反思]1103csp-s模拟测试99: 美梦
可能这次考得好的原因就是熬夜颓废到不算太晚?(啪) 但是是真心困. 考前跟akt说:我希望今天考一点那种不用动脑子,就是一直码的题. 然后开门T1一道线段树维护单调栈的板子我就...了 当时调了一上午 ...
- Maven配置setting.xml详细说明
<?xml version="1.0" encoding="UTF-8"?> <settings xmlns="http://mav ...
- p1156 题解(未完全解决)
题目描述 卡门――农夫约翰极其珍视的一条Holsteins奶牛――已经落了到“垃圾井”中.“垃圾井”是农夫们扔垃圾的地方,它的深度为D(2 \le D \le 100)D(2≤D≤100)英尺. 卡门 ...