文档章节

代码里的命名规则:错误的和正确的对比

编走编想
 编走编想
发布于 2013/06/11 15:02
字数 666
阅读 199
收藏 11

编程初学者总是把大量的时间用在学习编程语言,语法,技巧和编程工具的使用上。他们认为,如果掌握了这些技术技巧,他们就能成为不错的程序员。然而,计算机编程的目的并不是关于精通这些技术、工具的,它是关于针对特定领域里的特定问题创造出相应的解决方案,程序员通过相互合作来实现这些。所以,很重要的一点,你需要能精确的用代码表达出你的思想,让其他人通过代码能明白你的意图。

让我们先看看编程大师Robert C. Martin的杰作《Clean Code | 代码整洁之道》里的一句话:

“注释的目的是为了弥补代码自身在表达上的不足。”

这句话可以简单的理解为如果你的代码需要注释,最有可能是你的代码写的很烂。同样,如果在没有注释的情况下你无法用代码完整的表达你对一个问题或一个算法的思路,那这就是一个失败的信号。最终,这意味着你需要用注释来阐明一部分的思想,而这部分在代码里是看不出来的。好的代码能够让任何人在不需要任何注释的情况下看懂。好的编码风格能将所有有助于理解这个问题的所有信息都蕴含在代码里。

在编程理论中,有一个概念叫做“自我描述的源代码”。对于一段代码,一种常见的自我描述机制是遵循某种非严格定义的变量、方法、对象命名规则。这样做的主要作用就是使源代码更易读易懂。所以,也就更容易维护和扩展。

这篇文章里,我将举出一些例子,说明什么是“不好的代码”,什么是“清楚的代码”

命名要能揭示意图

如何命名,在编程中这永远都是个老大难问题。有些程序员喜欢简化、缩短或加密名称,使得只有他们自己能懂。下面让我们看一些例子:

不好的代码:

<!-- lang: java -->
int d;
// 天数
int ds;
int dsm;
int faid;

“d”可以表示任何东西。作者使用注释来表明他的意图,却没有选择用代码来表示。而“faid”很容易导致误解为ID。

清楚的代码:

<!-- lang: java -->
int elapsedTimeInDays;
int daysSinceCreation;
int daysSinceModification;
int fileAgeInDays;

全文:http://blog.jobbole.com/41022/

© 著作权归作者所有

共有 人打赏支持
编走编想
粉丝 147
博文 126
码字总数 107958
作品 0
海淀
程序员
私信 提问
加载中

评论(2)

编走编想
编走编想

引用来自“冷海圣”的评论

文章内容不明确,没有举例出所有或大部分的错误和正确的示例

这是转载的,所以只有一部分内容,全部内容的在最后的链接里
冷三叔
冷三叔
文章内容不明确,没有举例出所有或大部分的错误和正确的示例
Puppet代码书写规范(十九)

Puppet代码的规范 puppet对agent的配置清单主要集中在manifests和modules两个目录中,manifests和modules目录中清单代码文件的符号间距、缩进与空白的使用规范. *.pp文件 建议使用两个空格的软...

青衫解衣
06/29
0
0
C语言基础学习基本数据类型-变量的命名

变量的命名 变量命名规则是为了增强代码的可读性和容易维护性。以下为C语言必须遵守的变量命名规则: 1、 变量名只能是字母(A-Z,a-z),数字(0-9)或者下划线(_)组成。 2、 变量名第一个...

MayaTeacher
2016/08/16
3
1
区块链 100 讲:风格指南 (style guide) 说明----solidity 语言中文文档

1 概 述 本指南旨在约定solidity代码的编码规范。本指南是不断变化演进的,旧的、过时的编码规范会被淘汰, 而新的、有用的规范会被添加进来。 许多项目会实施他们自己的编码风格指南。如遇冲...

yanyan
07/10
0
0
Django的URLConf讲解及技巧二

一、使用命名组 使用命名组,能够使代码更加清晰,在做一些复杂模块的时候,只需看一下URLconf就大概知道怎么回事了。 命名组规则: 在 Python 正则表达式中,命名的正则表达式组的语法是 (?...

DjangoChina
2013/06/01
0
0
PHP命名空间(Namespace)的使用详解

对于命名空间,官方文档已经说得很详细[查看],我在这里做了一下实践和总结。 命名空间一个最明确的目的就是解决重名问题,PHP中不允许两个函数或者类出现相同的名字,否则会产生一个致命的错...

Surjur
2015/02/12
0
0

没有更多内容

加载失败,请刷新页面

加载更多

微服务分布式事务实现

https://www.processon.com/view/link/5b2144d7e4b001a14d3d2d30

WALK_MAN
今天
2
0
《大漠烟尘》读书笔记及读后感文章3700字

《大漠烟尘》读书笔记及读后感文章3700字: 在这个浮躁的社会里,你有多久没有好好读完一本书了? 我们总觉得自己和别人不一样,所以当看到别人身上的问题时,很少有“反求诸己”,反思自己。...

原创小博客
今天
4
0
大数据教程(9.5)用MR实现sql中的jion逻辑

上一篇博客讲解了使用jar -jar的方式来运行提交MR程序,以及通过修改YarnRunner的源码来实现MR的windows开发环境提交到集群的方式。本篇博主将分享sql中常见的join操作。 一、需求 订单数据表...

em_aaron
今天
3
0
十万个为什么之什么是resultful规范

起源 越来越多的人开始意识到,网站即软件,而且是一种新型的软件。这种"互联网软件"采用客户端/服务器模式,建立在分布式体系上,通过互联网通信,具有高延时(high latency)、高并发等特点...

尾生
今天
3
0
Terraform配置文件(Terraform configuration)

Terraform配置文件 翻译自Terraform Configuration Terraform用文本文件来描述设备、设置变量。这些文件被称为Terraform配置文件,以.tf结尾。这一部分将讲述Terraform配置文件的加载与格式。...

buddie
今天
5
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部