一起谈.NET技术,浅析.NET开发过程中命名的数量和人称

简介:   我们都明白命名的重要性,如果对命名不断地关注,就需要考虑命名中的动词和名词,特别的情况是动词的人称和名词的数量。  在.NET Framework的Guideline中,有专门一章讨论了命名规范,包括大小写、单词的选择等,却没有涉及到人称和数量,下面来讨论一下这两方面的内容。

  我们都明白命名的重要性,如果对命名不断地关注,就需要考虑命名中的动词和名词,特别的情况是动词的人称和名词的数量。

  在.NET Framework的Guideline中,有专门一章讨论了命名规范,包括大小写、单词的选择等,却没有涉及到人称和数量,下面来讨论一下这两方面的内容。

  名词的数量

  首先来看数量。名词的单数和复数在语义上有着明显的不同,为了提高可读性,数量需要认真地考虑。比如:

  • 属性(Property):System.Collections.Generic.DictionaryTKey, TValue中的Keys和Count是好的例子。字段与此类似;
  • 方法名中的名词:在JS中我们熟悉的getElementById和getElementsByTagName;
  • 局部变量:与属性相比,我们更可能遭遇的是局部变量。比如,用变量来表示一个人的名字,可以用string name; 如果是多个人的名字,则可以用Liststring names。

  一般地,单数表达的语义是?(0或1);复数表达的语义是*(0、1或多个)。关于名词的数量很容易理解,相关的规则也容易遵循。

  动词的人称

  下面再来考虑动词的人称。在需要考虑命名的对象中,包括命名空间、类型、各种类型成员,只有方法是动词,语义上表示一个行为。关于它的人称,来看一个.NET Framework中的例子。在  System.Collections.Generic.StackT中,有一个Contains(T item)方法,对于这样的代码:

if (theStack.Contains(1))
{
    // Do something.
}

  读起来像是:if the stack contains 1,比较通顺。是不是所有方法都要这样命名呢?没有。另两个方法Clear()和Push(T item)就不是如此,这个地方很让人困惑。先写成代码看看:

theStack.Push(3);
theStack.Clear();

  尝试像上面那样作为一个句子来读:the stack push 3; the stack clear,语法上不对,看起来也应该是第三人称。这里我也不确定为何如此,只能尝试来解释下。考察多个集合类型和其它类型后发现,所有使用第三人称的地方都是谓词函数,除了上面的Contains(T item),还有Directory.Exists(string path),不知道这是不是其中的命名规则呢?

  还要考虑注释

  一定程度上,注释也算是一种代码。一种是XML文档注释,在.NET Framework中,不管是对于类型还是类型成员,都使用了第三人称,这一点我们也可以遵循。其它的普通注释应该也可以遵循这个规则。

目录
相关文章
|
5月前
|
监控 Cloud Native 测试技术
.NET技术深度解析:现代企业级开发指南
每日激励:“不要一直责怪过去的自己,他曾经站在雾里也很迷茫”。我是蒋星熠Jaxonic,一名在代码宇宙中探索的极客旅人。从.NET Framework到.NET 8,我深耕跨平台、高性能、云原生开发,践行领域驱动设计与微服务架构,用代码书写技术诗篇。分享架构演进、性能优化与AI融合前沿,助力开发者在二进制星河中逐光前行。关注我,共探技术无限可能!
.NET技术深度解析:现代企业级开发指南
|
人工智能 芯片
D1net阅闻|OpenAI员工疯狂暗示,内部已成功开发ASI?被曝训出GPT-5但雪藏
D1net阅闻|OpenAI员工疯狂暗示,内部已成功开发ASI?被曝训出GPT-5但雪藏
|
11月前
|
SQL 小程序 API
如何运用C#.NET技术快速开发一套掌上医院系统?
本方案基于C#.NET技术快速构建掌上医院系统,结合模块化开发理念与医院信息化需求。核心功能涵盖用户端的预约挂号、在线问诊、报告查询等,以及管理端的排班管理和数据统计。采用.NET Core Web API与uni-app实现前后端分离,支持跨平台小程序开发。数据库选用SQL Server 2012,并通过读写分离与索引优化提升性能。部署方案包括Windows Server与负载均衡设计,确保高可用性。同时针对API差异、数据库老化及高并发等问题制定应对措施,保障系统稳定运行。推荐使用Postman、Redgate等工具辅助开发,提升效率与质量。
455 0
|
Linux API C#
基于 .NET 开发的多功能流媒体管理控制平台
基于 .NET 开发的多功能流媒体管理控制平台
253 9
|
Web App开发 前端开发 调度
一款基于 .NET + Blazor 开发的智能访客管理系统
一款基于 .NET + Blazor 开发的智能访客管理系统
232 8
|
前端开发 JavaScript C#
基于.NET8+Vue3开发的权限管理&个人博客系统
基于.NET8+Vue3开发的权限管理&个人博客系统
219 7
|
开发框架 算法 .NET
C#/.NET/.NET Core技术前沿周刊 | 第 15 期(2024年11.25-11.30)
C#/.NET/.NET Core技术前沿周刊 | 第 15 期(2024年11.25-11.30)
253 6
|
开发框架 Cloud Native .NET
C#/.NET/.NET Core技术前沿周刊 | 第 16 期(2024年12.01-12.08)
C#/.NET/.NET Core技术前沿周刊 | 第 16 期(2024年12.01-12.08)
273 6
|
监控 前端开发 API
一款基于 .NET MVC 框架开发、功能全面的MES系统
一款基于 .NET MVC 框架开发、功能全面的MES系统
540 5
|
开发框架 前端开发 JavaScript
ASP.NET MVC 教程
ASP.NET 是一个使用 HTML、CSS、JavaScript 和服务器脚本创建网页和网站的开发框架。
326 7