一聚教程网:一个值得你收藏的教程网站

最新下载

热门教程

.net官方编码方法和命名规则

时间:2022-07-02 10:53:22 编辑:袖梨 来源:一聚教程网

Visual Studio
 
编码方法
编码方法合并了软件开发的许多方面。尽管它们通常对应用程序的功能没有影响,但它们对于改善对源代码的理解是有帮助的。这里考虑了所有形式的源代码,包括编程、脚本撰写、标记和查询语言。
不建议将这里定义的编码方法形成一套固定的编码标准。相反,它们旨在作为开发特定软件项目的编码标准的指南。
编码方法分为三部分:
命名
注释
格式
命名
对于理解应用程序的逻辑流,命名方案是最有影响力的一种帮助。名称应该说明“什么”而不是“如何”。通过避免使用公开基础实现(它们会发生改变)的名称,可以保留简化复杂性的抽象层。例如,可以使用 GetNextStudent(),而不是 GetNextArrayElement()。
命名原则是:选择正确名称时的困难可能表明需要进一步分析或定义项的目的。使名称足够长以便有一定的意义,并且足够短以避免冗长。唯一名称在编程上仅用于将各项区分开。表现力强的名称是为了帮助人们阅读;因此,提供人们可以理解的名称是有意义的。不过,请确保选择的名称符合适用语言的规则和标准。
以下几点是推荐的命名方法。
例程
避免容易被主观解释的难懂的名称,如对于例程的 AnalyzeThis(),或者对于变量的 xxK8。这样的名称会导致多义性,而不仅仅是抽象。
在面向对象的语言中,在类属性的名称中包含类名是多余的,如 Book.BookTitle。而是应该使用 Book.Title。
使用动词-名词的方法来命名对给定对象执行特定操作的例程,如 CalculateInvoiceTotal()。
在允许函数重载的语言中,所有重载都应该执行相似的函数。对于那些不允许函数重载的语言,建立使相似函数发生关系的命名标准。
变量
只要合适,在变量名的末尾追加计算限定符(Avg、Sum、Min、Max、Index)。
在变量名中使用互补对,如 min/max、begin/end 和 open/close。
鉴于大多数名称都是通过连接若干单词构造的,请使用大小写混合的格式以简化它们的阅读。另外,为了帮助区分变量和例程,请对例程名称使用 Pascal 大小写处理 (CalculateInvoiceTotal),其中每个单词的第一个字母都是大写的。对于变量名,请使用 camel 大小写处理 (documentFormatType),其中除了第一个单词外每个单词的第一个字母都是大写的。

热门栏目