中英文代码对比系列之Java一例
这个系列将对同一段代码进行中文命名和英文命名两个版本的比较. 目的包括, 演示中文命名, 发现命名时可能遇到的问题, 探讨代码风格(中文命名的'套路')等. 示例中的命名风格仅基于个人非常有限的实践, 希望抛砖引玉.
不在讨论范围内的是:
- 中英文代码的可读性孰高孰低. 个人相信用英文和中文都能写出可读性很好的代码. 区别仅在于母语不同的开发者对哪个版本更敏感, 读写维护起来更省工.
- 原代码本身的优化/风格问题. 如果认为有更有代表性的代码, 请不吝推荐.
- 代码输入的便捷性. 前作对在代码中使用中文命名的质疑与回应'中文输入太慢, 降低开发效率'一节中有所涉及, 打算另开题探讨.
下面一段代码选自Clean Code: A Handbook of Agile Software Craftsmanship一书, 19页. 已经经过了作者的命名改进. 由于本人也没有看过全书, 如果此段代码在此书之后某节仍有命名改进, 请麻烦指出.
public List<Cell> getFlaggedCells() { List<Cell> flaggedCells = new ArrayList<Cell>(); for (Cell cell : gameBoard) if (cell.isFlagged()) flaggedCells.add(cell); return flaggedCells; }
中文命名版:
public List<格类> 取被标的格() { List<格类> 被标的格 = new ArrayList<格类>(); for (格类 某格 : 雷区) if (某格.是被标的()) 被标的格.add(某格); return 被标的格; }
这里触及了几处典型的中文命名问题. 首先, 是没有大小写区分类和变量名(Cell cell). 个人采用的是在类名中使用后缀'类'. 暂时没有发现有类名本身就用'类'结尾的情况(那样会出现XXX类类
的命名), 即使如此, 应该可以用改为类型
结尾来规避(就成为XXX类型类
). 变量名也与类名有一致之处, 就是所有关于格类的变量都用xx格命名, 与英文命名方法相同.
下面, 是单复数的区别. flaggedCells
是个List, 它用复数命名的意思是"可能包含多个格". 而实际上这个变量可能只包含一个格. 中文中的名词不分单复数, 正好符合"这个变量有可能含有单个或多个元素"这个语义. 因此命名为被标的格
感觉可行. 假如语义需要强调有多个(不可能只有单个或没有), 可以考虑加上修饰如多个
前缀等等.
相比之下, 如何在for循环中表示单数有些麻烦. 这个for循环的语义大概是:for one/each cell in the gameboard, if the cell is flagged, add the cell to...
, 原代码中没对one/each cell
和the cell
作出区分. 对应中文大约是对于雷区中的每一格, 如果这一格是被标的, 就把这一格加到...
. 同样也很难在代码中用一个词体现每一格
和这一格
这两个有差别的语义. 另外可能的命名有一格
, 每格
, 此格
, 在不需突出单数的情况下直接用格
等等.
get前缀的方法名, 中文采用了对应的取
, 用动词短语可以和变量名区分, 这和英文命名类似. 有个潜在的技术问题, 就是Bean中get的特殊规则. 个人认为在这种情况下可以采用混用, 即get被标的格
. 这个Spring Boot的演示程序中就是如此.
is前缀的方法名, 一般认为是返回布尔值的方法. 这里采用的命名是被标的
是个很直白的对应命名. 既保留了是
作为表示返回布尔值, 也保留了被动语态. 个人觉得稍显累赘, 但与其他命名一致(取'被标的'格, '被标的'格), 并且易于使用在其他情况, 比如isRunning
->是运行中的
, isTerriblyDamaged
->是被严重损坏的
等等. 不失为一种可行的风格. 这里原本使用了是被标记的
, 但感觉去掉一字也可以接受.
此外, gameBoard
没有采用直译, 而是用雷区
, 因为这个代码在原作中是假想从一个mine sweeper game(扫雷游戏)中选取的, 因此感觉比较适合. 当然, 原代码中gameBoard
也可以用mineField
使这一段单独出来的代码更有语境. 但正如开头声明, 此文并不对中英文代码之间的可读性进行比较. 这里也就不拘泥于找到gameBoard
的对应中文了.
再次欢迎各种推敲.
2017-11-09
低调大师中文资讯倾力打造互联网数据资讯、行业资源、电子商务、移动互联网、网络营销平台。
持续更新报道IT业界、互联网、市场资讯、驱动更新,是最及时权威的产业资讯及硬件资讯报道平台。
转载内容版权归作者及来源网站所有,本站原创内容转载请注明来源。
- 上一篇
使用JSDoc提高代码的可读性
工作了四年多,基本上都在围绕着 JavaScript 做事情。 写的代码多了,看的代码也多了,由衷的觉得,写出别人看不懂的代码并不是什么能力,写出所有人都能读懂的代码,才是真的牛X。 众所周知, JavaScript 是一个弱类型的脚本语言,这就意味着,从编辑器中并不能直观的看出这段代码的作用是什么,有些事情只有等到代码真正的运行起来才能够确定。 所以为了解决大型项目中 JavaScript 维护成本高的问题,前段时间我们团队开始使用 TypeScript,但是由前几年所积累下来的代码,并不是说改立马都能全部改完的,所以这个重构将是一个漫长的过程。 在重构同时我们还是需要继续维护原有的 JavaScript 项目的,而 JSDoc 恰好是一个中间过渡的方案,可以让我们以注释的形式来降低 JavaScript 项目的维护难度,提升可读性。 作用 本人使用的是 vs code 编辑器,内置了对 jsdoc 的各种支持,同时还会根据部分常量,语法来推测出对应的类型 可以很方便的在编辑器中看到效果,所以下面所有示例都是基于 vscode 来做的。 首先,JSDoc 并不会对源码产生任何的影响,...
- 下一篇
为clang添加中文关键字
知乎原文地址 作者:@狗屎咖啡 以clang为基础做了一个与C++、C兼容中英文关键字的编译器 swizl/cnlang 原理就是加与英文关键字等效的中文关键字 在/include/clang/Basic/TokenKinds.def 中 用ALIAS添加中文关键字 例如 KEYWORD(char, KEYALL) ALIAS("字", char, KEYALL) 在 /lib/Basic/IdentifierTable.cpp 中 加个头文件 #include "llvm/ADT/StringSwitch.h" 在 tok::PPKeywordKind IdentifierInfo::getPPKeywordID() const 里 用 llvm::StringSwitch 添加 中文宏 例如 //default: return tok::pp_not_keyword; default: return llvm::StringSwitch<tok::PPKeywordKind>(Name) .Case("如", tok::pp_if) .Case("定义", tok::p...
相关文章
文章评论
共有0条评论来说两句吧...
文章二维码
点击排行
推荐阅读
最新文章
- CentOS8安装Docker,最新的服务器搭配容器使用
- SpringBoot2整合MyBatis,连接MySql数据库做增删改查操作
- CentOS8,CentOS7,CentOS6编译安装Redis5.0.7
- 设置Eclipse缩进为4个空格,增强代码规范
- Docker使用Oracle官方镜像安装(12C,18C,19C)
- CentOS8编译安装MySQL8.0.19
- SpringBoot2整合Redis,开启缓存,提高访问速度
- SpringBoot2配置默认Tomcat设置,开启更多高级功能
- Hadoop3单机部署,实现最简伪集群
- CentOS7,CentOS8安装Elasticsearch6.8.6