提问人:DarkPixel 提问时间:2/11/2014 最后编辑:Vincenzo MaggioDarkPixel 更新时间:2/13/2014 访问量:521
首字母缩略词,你使用它们吗?为什么?[关闭]
Acronym, do you use them? And Why? [closed]
问:
就我个人而言,我认为这是软件开发中的一种不好的做法(参见 Robert C. Martin 的 Clean Code)。但我很好奇为什么人们仍然使用它们。
我说的是文件名、变量名、类名、函数名等中的首字母缩略词。
如果您回答,请说明上下文(例如:语言、大/小公司)。
编辑:我不是在谈论常识的技术首字母缩略词(例如:sql,html,css等),而是企业内部的首字母缩略词。
两个例子:
1)在每个班级名称前加上两个代表公司的字母
SuperCompany: SCNode, SCObject
2) 特定的模块名称
Graphic: GRTexture, GRMaterial
答:
背景:中型公司
领域:医学工程
语言:Python、JavaScript、C/C++、Perl 等。
有很多理由不在您的源代码中使用首字母缩略词,但在我们的情况下,我们受到 FDA 和其他几个政府机构的监管/监管,这些机构要求我们在整个“系统”(用于审计/文档目的)中放置与代码无关的注释——我看不出我们如何在不使用首字母缩略词的情况下完成这个过程。
另一方面:如果让我选择,我不会将他们要求我们添加到源代码中的 90% 的内容添加,这将有效地消除我们代码中所有深奥的歧义(首字母缩略词和法规跟踪号)。
所以,是的,我使用它们,不,我宁愿不——但我的行业需要它。
这个问题没有正确的答案,但我认为,只有当其他程序员立即知道它的扩展或含义时,才应该使用首字母缩略词。常见的示例是名称,例如 或 ,其中较长的版本会降低代码的可读性。dvdPlayer
cssClass
如果您有疑问,请不要使用首字母缩略词,但不要调用您的类而不是 ,因为严格的无首字母缩略词 codex。HypertextTransferProtocolRequest
HttpRequest
你确定“干净的代码”说明了首字母缩略词吗?我认为它说的是可读性。首字母缩略词并不总是不可读且毫无意义。至少在两种情况下需要首字母缩略词。
一种是其他程序员(css、html、DAO、DTO、regExp、sql 等)可以很好地理解的技术语言,你不应该避免他们,他们是一等公民。尝试替换它们,您将与其他开发人员产生很多误解。
第二条规则是:使用与客户相同的语言。他们不会更改他们使用的名称。它们有自己的首字母缩略词(因为我们有 SQL、CSS 等)。如果你开始在代码中改变它,你很快就会对业务产生很多误解
评论