文档章节

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

编走编想
 编走编想
发布于 2013/06/11 15:02
字数 666
阅读 198
收藏 11
点赞 0
评论 2

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

让我们先看看编程大师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/

© 著作权归作者所有

共有 人打赏支持
编走编想
粉丝 133
博文 120
码字总数 107958
作品 0
海淀
程序员
加载中

评论(2)

编走编想
编走编想

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

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

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

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

青衫解衣 ⋅ 2017/10/09 ⋅ 0

C语言基础学习基本数据类型-变量的命名

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

MayaTeacher ⋅ 2016/08/16 ⋅ 1

常用 Java 静态代码分析工具的分析与比较

简介: 本文首先介绍了静态代码分析的基本概念及主要技术,随后分别介绍了现有 4 种主流 Java 静态代码分析工具 (Checkstyle,FindBugs,PMD,Jtest),最后从功能、特性等方面对它们进行分析...

IBMdW ⋅ 2011/07/01 ⋅ 20

「数控干货」基于UG CLS文件使用 C 语言制作智能后处理工具

  莫莫小贴士:点击上方↑↑"UG数控编程"即可免费订阅如此好的数控平台哦!   1 前言   UG 后处理操作是 UGCAM 数控加工工作中一个重要环节,主要任务是把在 UG 加工环境下生成的加工刀...

UG数控编程 ⋅ 06/14 ⋅ 0

程序员如何保持优秀

1. 小范围的选择一些有用技术,透彻的学习它们,拥抱它们。然后不断的扩展这个范围。 2. 理解各种数据结构的优点和缺点,包括它们在内存中和在硬盘上的各自表现。 3. 理解各种算法的优点和缺...

oschina ⋅ 2012/10/25 ⋅ 38

Django的URLConf讲解及技巧二

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

DjangoChina ⋅ 2013/06/01 ⋅ 0

Clean Code第二章:有意义的命名 --阅读与讨论

本章,作为整洁代码的头一步,致力于规范命名规则。 names.png 图片来自 所谓名不正则言不顺,命名的好,代码可读性一下子就可以提高一大块。 本章讲解了十多种命名时的注意事项。 提到命名,...

徐朝_尼克徐 ⋅ 2016/11/25 ⋅ 0

PHP命名空间(Namespace)的使用详解

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

Surjur ⋅ 2015/02/12 ⋅ 0

PHP命名空间(Namespace)初探

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

豆浆Melon ⋅ 2013/05/04 ⋅ 34

java编程基本规范

开发工具 1. 首选Eclipse,在有需要做GUI设计的时候可以选择NetBeans。 命名规则(驼峰命名法) 0. package名字全部小写,格式为: 公司名.项目名.包名.类名 。 1. 所有的类名,方法名和变量...

YuanyuanL ⋅ 2014/02/13 ⋅ 0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

从 Confluence 5.3 及其早期版本中恢复空间

如果你需要从 Confluence 5.3 及其早期版本中的导出文件恢复到晚于 Confluence 5.3 的 Confluence 中的话。你可以使用临时的 Confluence 空间安装,然后将这个 Confluence 安装实例升级到你现...

honeymose ⋅ 今天 ⋅ 0

用ZBLOG2.3博客写读书笔记网站能创造今日头条的辉煌吗?

最近两年,著名的自媒体网站今日头条可以说是火得一塌糊涂,虽然从目前来看也遇到了一点瓶颈,毕竟发展到了一定的规模,继续增长就更加难了,但如今的今日头条规模和流量已经非常大了。 我们...

原创小博客 ⋅ 今天 ⋅ 0

MyBatis四大核心概念

本文讲解 MyBatis 四大核心概念(SqlSessionFactoryBuilder、SqlSessionFactory、SqlSession、Mapper)。 MyBatis 作为互联网数据库映射工具界的“上古神器”,训有四大“神兽”,谓之:Sql...

waylau ⋅ 今天 ⋅ 0

以太坊java开发包web3j简介

web3j(org.web3j)是Java版本的以太坊JSON RPC接口协议封装实现,如果需要将你的Java应用或安卓应用接入以太坊,或者希望用java开发一个钱包应用,那么用web3j就对了。 web3j的功能相当完整...

汇智网教程 ⋅ 今天 ⋅ 0

2个线程交替打印100以内的数字

重点提示: 线程的本质上只是一个壳子,真正的逻辑其实在“竞态条件”中。 举个例子,比如本题中的打印,那么在竞态条件中,我只需要一个方法即可; 假如我的需求是2个线程,一个+1,一个-1,...

Germmy ⋅ 今天 ⋅ 0

Springboot2 之 Spring Data Redis 实现消息队列——发布/订阅模式

一般来说,消息队列有两种场景,一种是发布者订阅者模式,一种是生产者消费者模式,这里利用redis消息“发布/订阅”来简单实现订阅者模式。 实现之前先过过 redis 发布订阅的一些基础概念和操...

Simonton ⋅ 今天 ⋅ 0

error:Could not find gradle

一.更新Android Studio后打开Project,报如下错误: Error: Could not find com.android.tools.build:gradle:2.2.1. Searched in the following locations: file:/D:/software/android/andro......

Yao--靠自己 ⋅ 昨天 ⋅ 0

Spring boot 项目打包及引入本地jar包

Spring Boot 项目打包以及引入本地Jar包 [TOC] 上篇文章提到 Maven 项目添加本地jar包的三种方式 ,本篇文章记录下在实际项目中的应用。 spring boot 打包方式 我们知道,传统应用可以将程序...

Os_yxguang ⋅ 昨天 ⋅ 0

常见数据结构(二)-树(二叉树,红黑树,B树)

本文介绍数据结构中几种常见的树:二分查找树,2-3树,红黑树,B树 写在前面 本文所有图片均截图自coursera上普林斯顿的课程《Algorithms, Part I》中的Slides 相关命题的证明可参考《算法(第...

浮躁的码农 ⋅ 昨天 ⋅ 0

android -------- 混淆打包报错 (warning - InnerClass ...)

最近做Android混淆打包遇到一些问题,Android Sdutio 3.1 版本打包的 错误如下: Android studio warning - InnerClass annotations are missing corresponding EnclosingMember annotation......

切切歆语 ⋅ 昨天 ⋅ 0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

返回顶部
顶部