CleanCode笔记---有意义的命名

C#里用HttpListener实现WEB API接口服务端 本文介绍了一个基于WinForm的HTTP服务实现方案。该方案使用HttpListener类创建了一个支持JSON POST请求处理的轻量级Web服务器,主要特点包括:1) 纯线程方式实现请求监听和处理;2) 提供标准化的JSON响应格式;3) 支持自定义请求处理逻辑;4) 包含完整的日志记录功能。代码示例展示了如何初始化服务、处理不同类型的请求(包括JSON POST),并提供了线程安全的UI更新机制。该实现适用于需要简单HTTP接口的Windows桌面应用程序,可作为程序间通信的基础设施。 阅读详情

转载请附带本文地址,谢谢!

1. 命名应该和实际意义相符合

反例:

int w;
int h;

public int fun(){
    return w*h;
}

从代码中看不出任何信息,w和h是何含义?

不如改为:

int width;
int height;

public int calculateArea(){
    return width*height;
}

这样没有注释也能看懂代码的意图.


2.避免误导

如果仅仅给你一个accountList,很容易让人误以为是一个账户类表.

Account[] accountList;

//此处又很长的代码

accountList = getAccountList(); //你能辨别出accountList是什么吗?

为了避免误导,应该改为:

Account[] accountGroup;

//此处又很长的代码

accountGroup = getAccountGroup(); //你能辨别出accountGroup是什么吗?

3.做有意义的区分

现在有三个类:

public class Account{}

public class AccountInfo{}

public class AccountData{}

仅仅从类名你能区分这三个类有什么区别吗?
既然要区分他们就应该取一个有意义的名称区分.


4.用读得出的名称

有的程序员喜欢用自造的词语,比如:

public void lxmcreateData(){
    //代码内容
}

你能读出来上面函数的名称吗?函数本意是想创造数据,但是lxm是什么意思?翻到类头注释才知道,作者叫Lixiaoming.
如果改为下面这样,是不是更好读呢?

public void createData(){
    //代码内容
}

5.用可搜索的名称

经常在代码中可以见到类似a,b,w,h,e等这样的命名,而且同一个类中多次出现,特别是作为临时变量的i,j,k.当想查找时,编辑器也不知道你想要查找哪一个.
例如:

private List<Student> studentList;
public float getMathAvgScore(){
    float s = 0;
    for(int i = 0; i < studentList.size(); i++){
        s = s + studentList.get(i).getMathScore();
    }
    float a = s/studentList.size();
    return a;
}

public float getAvgScore(){
    float s = 0;
    for(int i = 0; i < studentList.size(); i++){
        s = s + studentList.get(i).getTotalScore();
    }
    float a = s/studentList.size();
    return a;
}

如果改为下面这样,你觉得哪个更好呢?

private List<Student> studentList;
public float getMathAvgScore(){
    float mathTotalScore = 0;
    for(Student student : studentList){
        mathTotalScore = mathTotalScore + student.getMathScore();
    }
    float mathAvgScore = mathTotalScore/studentList.size();
    return mathAvgScore;
}

public float getAvgScore(){
    float totalScore = 0;
    for(Student student : studentList){
        totalScore = totalScore + student.getTotalScore();
    }
    float avgTotalScore = totalScore/studentList.size();
    return avgTotalScore;
}

6.不要使用命名编码

什么是命名编码?就像前面的lxmcreateData()函数名就是命名编码.

命名前缀

就像前面的lxmcreateData()一样,该类中存在很多类似lxmXXX的函数,变量.
在命名时应避免使用这样的前缀

命名后缀

使用Eclipse时,我们生命一个变量时,往往会给出命名提示:

String nameString

这是很不必要的,不需要在变量后面都带上该变量的类型,除非该变量的命名不足以表现出其类型.


7.避免思维映射

每一个变量应明确其含义,不要让人在大脑中给其一个含义映射!
比如:

for(int i = 0; i < studentList.size(); i++){
    s = s + studentList.get(i).getMathScore();
}

与下面相比:

for(Student student : studentList){
    mathTotalScore = mathTotalScore + student.getMathScore();
}

下面的代码更直观,而上面的代码会让人去记住s代表什么含义.


8.类名

类名和对象名应该是名词活名词短语,如Customer,WikiPage,Account,AccountParser等,避免使用Manager,Processor,Data,Info等这样的类名.类名不应该是动词.


9.方法名

方法名应该是动词或动词短语,如postPayment,deletePage或save.
属性访问与修改和断言应该根据其命名,并依照javabean标准加上get,set,is前缀.
如:

String name = person.getName();

person.setName("Jack");

player.isPlaying();

10.别装幽默

命名应该是直来直去的名称,不要使用一些俗语或俚语(不要以为别人都和你一样英文阅历很深).
别用whack()来表示kill().


11.每个概念对应一个词

如果你要写一个控制类,比如控制音频类.如果使用了AudioManager就不要在使用AudioController.否则别人是弄不懂二者之间区别.


12.别用双关语

比如add一词又很多含义,不要为了保持方法名一致就命名为add.
把单个条目放到集合中可以用put,不要用add;
把单个条目放大数据库中可用insert,不要用add.


13.使用解决方案领域的名称

有时同一个事物在不同领域有不同的含义,在写代码的过程中要用和项目相关领域的词汇命名.


14.使用源自于所涉及问题领域的名称

尽量使用问题所在的领域的词语来命名,这样可以明确代码解决问题的领域.


15.添加有意义的语境

有些词语会有一词多义的现象,如果找不到代替该词更好名称,那么至少给该词添加能明确含义的语境.


16.不要添加没用的语境.

就像前面的lxmcreateData()一样,前缀lxm是没有任何含义的.一定不要附带这样的没有意义的语境.

Docker:快速部署 Temporal 工作流引擎的技术指南 Temporal是一个开源的分布式工作流引擎,适用于复杂业务流程(如订单处理、支付流程等),提供状态持久化、自动重试、多语言SDK支持等特性。部署简单,支持Docker Compose,包含核心服务、Web UI及数据库。以TypeScript为例,开发者可快速编写工作流(如订单处理)和Worker,通过CLI或SDK启动和管理。Temporal简化了分布式系统的可靠性设计,适合电商、自动化任务等场景。 阅读详情

相关推荐

学术报告系列(二) - 智能自主作业机器人感知与控制技术及发展趋势

收集整理于2022年模式识别高峰论坛湖南大学王耀南院士报告(报名题目:智能自主作业机器人感知与控制技术及发展趋势)

Make something people want. 4699

2023编程必会的100个代码大全,建议立刻收藏

编程必会的100个代码大全,建议收藏

2201_75571291的博客 6万+

汽车电缆选型实战:基于ISO 19642-3~12的7类电缆电压/材料/场景对照表

本文详细解析了基于ISO 19642-3~12标准的7类汽车电缆选型实战,涵盖电压等级、导体材料和场景应用的对照表。通过全参数速查表和典型选型陷阱分析,帮助工程师快速掌握从低压信号线到高压动力电缆的选型逻辑,提升新能源汽车与智能驾驶技术的安全性和可靠性。

weixin_29043895的博客 366

游戏代码 (可复制)

if(j==3) cout<<"你使用了太极神功(盗版)"<<endl<<"========================================="<<endl<<"lose!if(j==4) cout<<"你变身成了盖亚"<<endl<<"========================================="<<endl<<"lose!cout<<"选择狒狒"<<endl<<"=========================================="<<endl;

songhuaizhi的博客 1万+

STM32双ADC同步采样实战:FFT测量相位差的5个关键细节

本文深入探讨了利用STM32双ADC同步采样结合FFT算法精确测量信号相位差的实战技巧。文章聚焦五个关键细节:确保ADC时钟同源、优化DMA缓冲区设计、信号调理与窗函数选择、精确的相位提取与解缠绕,以及系统误差校准与验证。这些细节是提升相位差测量精度、确保系统稳定性的核心,尤其强调了STM32配置中易被忽视的时钟同步问题。

oauth7security的博客 597

零中频架构实战:用Matlab模拟AD9361收发信号(附完整代码)

本文详细介绍了如何使用Matlab模拟AD9361射频收发器的零中频架构,解决镜像干扰等关键挑战。通过完整的代码示例和系统级建模方法,帮助工程师掌握RFIC设计中的自适应校准算法和性能优化技巧,特别适用于SDR系统开发。

weixin_30733003的博客 543

初学编程100个代码

初学编程都有哪100个代码呢?29.将一个列表中的元素按照长度从小到大排序:(需完善)

zy1992As的博客 5万+

OI 生涯回忆录 《Pilgrimage》

前言 于 NOI2020 后写下本文。 本文简单提及了在写作时尚能回忆起来的,在我的 OI 生涯中对我的影响重大的人、事、比赛等。 写作本文,旨在在回忆允许的范围内,对 OI 生涯进行一定程度上的梳理,总结。 开端 入门 我最早接触计算机程序设计,是在小学。 那时候,我的数学成绩不错,就被老师推荐去学习编程。 就这样,我在局前街小学的何静老师的指导下,走上了编程的道路。 小学时的编程,与其说是 “竞赛” ,不如说是 “兴趣班” 。 当时,包括我在内,很多小孩子天性是浮躁的。支撑我对着无聊的代码学下去的,并不

cz_xuyixuan的博客 1万+

50个JAVA常见代码大全:学完这篇从Java小白到架构师

Java,作为一门流行多年的编程语言,始终占据着软件开发领域的重要位置。无论是初学者还是经验丰富的程序员,掌握Java中常见的代码和概念都是至关重要的。

linzhongshu的专栏 1万+

2022年TI杯模拟电⼦系统设计专题邀请赛——李萨如图形演示装置

本次装置主要是对输入的正弦信号进行频率变换,并将原输入正弦信号作为 X 轴信号、变换后的正弦信号作为 Y 轴信号,绘制李萨如图形。采用 EK-TM4C123GXL 板卡作为主控;频率变换采用“锁向环+计数器”实现 1-5 倍频的频率变换控制;李萨如图形采用两个 AD通道采集原输入的正弦信号作为 X 轴信号和频率变换后的正弦信号作为 Y 轴信号,绘制李萨如图形。

qq_45890466的博客 7772

液态神经网络(LNN):打破AI“静态快照”的连续动力学革命---AI大模型系统从零开始0029

MIT研究团队受秀丽隐杆线虫神经系统的启发,开发出革命性的液态神经网络(LNN)。该技术通过连续微分方程建模神经元动态,实现输入响应速度的自适应调节,解决了传统AI模型静态化、高能耗和低解释性的痛点。LNN具有三大突破性优势:仅需少量神经元(如20个)即可完成复杂任务;能处理非均匀时序数据;在自动驾驶、医疗监测等领域展现出卓越的适应性和鲁棒性。这项将生物智能与数学建模完美融合的技术,有望成为下一代AI的核心架构,目前已在无人机导航等场景验证了其高效性,被预测为2026年最具潜力的AI突破方向。

添柴程序猿的专栏 382

极简 Python:10 段代码,学会基础 python

本篇共包含 10 段简单的 Python,涉及常用语法和常用库(但毫无疑问删减了很多,比如没有字典)任何不懂的地方可直接留言~注:如果某个地方以 “#” 开始意思是:这是注释。

2401_85339817的博客 4923

数学之美:欣赏超越数e

文章目录一、e为何物?二、利息与e的关系1、利息问题2、计算利息3、欣赏螺旋线(1)螺旋线概述(2)绘制螺旋线三、e和π 一、e为何物? e是一个无限不循环小数,其值约等于2.718281828…,它是一个超越数,有时也称为欧拉数(Euler’s Number)。 以e为底的对数称为自然对数(Natural Logarithm),数学中使用自然这个词的还有自然数(Natural Number)。 这里的“自然”并不是现代人所习惯的“大自然”,而是有点儿“天然存在,非人为”的意思。 二、利息与e的关系

howard2005的专栏 1719

《CleanCode代码整洁之道》笔记

《代码整洁之道》摘要

weixin_45012798的博客 694

锂电池充电器电路设计 里面有电路

锂电池充电器电路设计 里面有电路 3.7V升压到5V电路设计。

温度PID控制PLC程序

温度PID稳定控制程序,适用于欧姆龙PLC,对其他PLC也具有很大参考价值

cleanCode-有意义的命名

代码当中充满了命名,方法、函数、类或者接口。命名是代码表达力的重要组成部分。没有好的命名,代码整洁也无从谈起。 下面谈一谈关于命名的那些事。 不同实体(类、方法等)之间的命名规则略有不同,此外大同小异。他们有一个最共同的目的,就是要有表达力,让代码更清晰。遵循如下几条规则,就能事半功倍。 1.命名要足够的细节,能够完全描述被命名的实体的实际作用。不要使用注释去进行额外的解释...

neverland 443

最新的sdio 4.0 spec 协议标准 带书签 高清完整PDF版

Part-E1-SDIO-Specification-Ver4.00-Final-120220.pdf:最新的sdio 4.0 spec 协议标准 带书签 高清完整PDF版,包括SDIO 接口的外设,SDIO 接口官方协议等。

cleanCode[1]:有意义的命名

为什么要有意义的命名: 我们都曾经说过有朝一日再回头清理那些糟糕的代码,然而最终总是弃之不顾。稍后等于永不,我们需要立即行动,写优雅的代码。 写代码的过程中,读占的比例很大,所以首先要让代码易读。 有意义命名的几大规则: 1、命名即其意 例:int daysSinceCreation; 2、做有意义的区分 例:由a1,a2的命名方式改为source,destination 3、使用读得出来的命名 ...

take it easy 188

WINCC7.3破解文件

WINCC7.3硬件够破解文件,有需要的下载!WINCC7.3硬件够破解文件,有需要的下载!

CleanCode-命名

clean code 学习笔记-命名

weixin_44831041的博客 387

CleanCode学习笔记(1)

本文中的观点都是摘自《Clean Code》 书中有对观点更加详细的解释和说明 命名 有意义的命名 变量、函数、类的命名应当表明意义、作用以及使用方式 命名避免误导 不要将account的组合命名为accountList,除非它真的是List 避免使用区别非常小的命名,比如XYZControllerForEfficientHandlingOfStrings和XYZControllerForEfficientStorageOfStrings 同样的概念使用相同命名,命名前后不一致也是问题 有意义的区分

夏末微凉的博客 340

CLeanCode -- 第二章 -- 有意义的命名

这里写自定义目录标题part02 - 有意义的命名规则 - 01:名副其实规则 - 02:避免误导规则 - 03:做有意义的区分规则 - 04:使用读得出来的名字规则 - 05:使用可搜索的名称规则 - 06:类名规则 - 07:方法名 part02 - 有意义的命名 规则 - 01:名副其实 变量、函数或类的命名,最好已经告诉你所有的大问题: 它为什么存在; 做什么事情; 应该怎么用; 反例:名称 d 什么也没有说明; int d; // elpased time in days

S_numb的博客 299

CleanCode---代码整洁之道笔记

一、整洁代码 糟糕 的代码想做太多事,它意图混乱、目的含混。整洁的代码只做好一件事,力求每个函数、每个类和每个模块都全神贯注于一事,完全不受四周细节的干扰和污染。如果对象功能太多,最好是切分为两个或者多个对象。如果方法功能太多,可以使用抽取手段进行重构,从而得到一个能较为清晰地说明自身功能的方法,以及另外数个说明如何实现这些功能的方法。 整洁的代码从 不隐藏设计者的意图,充满了干净利落的抽象和直截了当的控制语句。 简单的代码有以下几点要求: 能通过所有测试。高效可用的代码是第一位。 没有重复的代码。如果同

zhaozhen的博客 1841

CleanCode、安全编码规范

Clean Code 是由 Robert C. Martin 提出的编写高质量代码的原则。安全编码规范旨在防止常见的安全漏洞,提高代码的安全性。在这个例子中,我们创建了一个。

呆咖啡的博客 909

Java进阶之路【代码篇】——《CleanCode》编程规则精编(1)命名

阅读本文之前请确保你已与我达成共识。即,代码是一门讲规矩的艺术。前一段时间因为要参加一个有关重构的培训,匆匆读完了《CleanCode》一书,参加完培训后看到之前的读书笔记,发现又有了一番新的认识,因此在此加以总结。希望能够与愿意把代码当成一件艺术品去精心打磨的同学们一起来学习和研究如何把代码写的“优雅”。 简洁优秀的代码的好处不需更多的解说,但如何写出“优雅”的代码,还需要在个人的实践中仔细的体

在咖啡里溺水的鱼 1217

CleanCode读书笔记

第一章 整洁代码 什么是整洁代码? 整洁的代码应当代码正确,简单直接,应有单元测试和验收测试,清晰易读,只做一件事,尽量少的依赖关系; “如果每个例程都让你感到深含己意,那就是整洁代码”。 第二章 有意义的命名 2.1 名副其实 如果名称需要注释来补充,那就不算时名副其实。 2.2 避免误导 避免留下掩藏代码本意的错误线索;避免使用与本意相悖的词。 如:sco 不能做变量名,它是UNIX平台专有名称。 2.3 做有意义的区分 如果名称相异,其意思应该不同。 如:accountData

weixin_42696160的博客 661

《CleanCode-代码整洁之道》读书笔记

一本非常经典的书,读了之后,我感觉在如何写出简洁优雅的高质量代码方面对我很有启发。书中从各个方面,列举了许多原则与标准,但我们写代码的时候,不可能将这些东西都清楚记着并时刻提醒自己不能“违规”,这样就如同负重前行,不仅走得慢,还会累死。 所以我个人总结了以下几条比较通用且重要的规则:   1. 一切代码与注释都是有实际意义的,没有冗余,整洁干净   2. 代码能通过所有测试,运行高效   3....

路漫漫 始于足下 1万+

clean code php,CleanCode代码规范

Clean Code代码规范1、有意义的命名1.1、名副其实知道函数发生了什么,传入什么,返回什么1.2、避免误导避免留下隐藏代码本意的错误线索1.3、做有意义的区分废话是另外一种没有意义的区分1.4、使用读得出来的名称读起来像人话1.5、使用可搜索的名称2、类名2.1、类名和对象名应该是名词或者名词短语如Customer 、WikiPage、 AddressParser,避免使用Manager、...

weixin_33601504的博客 286

《代码整洁之道:CleanCode》学习总结

概括总结: 整洁代码: 培养整洁代码的意识,经常维护项目中的模块保持整洁。整洁的代码增强可维护性,并且能提高工作效率。 2.有意义的命名: 名副其实的命名,变量名,函数,类名等。命名也有意义且能让人读懂。错误示例:名字没有含义,a1 a2。 3.函数: 函数要单一,并且只做一件事。这样不容易出错,并且好复用,可维护性强大。 4.注释: 尽量不写注释,...

路漫漫亦无涯 1712
上一篇: Android官方培训课程中文版(v0.9.3)
下一篇: Android实现输入手机号时自动添加空格
DevWiki
博客等级 码龄12年 23粉丝 59原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

DevWiki

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值