代码命名规范

简介: 代码命名规范

代码的书写规范是重重之重,保持代码书写的一致性,对进行代码的维护和交流有着很重要的地位。

由于目前我大多都是用VB进行代码的编写,下面我就主要介绍在VB中代码的命名规范。
控件命名 窗体命
名字应该能够标识事物的特性,并且与业务挂钩。


名字一律使用英文单词,而不能为拼音。 名字可以有两个或三个单词组成,但不应多于4个,控制在3至30个字母以内。


在名字中,多个单词用大写第一个字母(其它字母小写)来分隔。例如:IsSuperUser


在具体任务开发中,如果有特定的命名约定,则在相应的软件开发计划中予以明确定义及上报质量管理部审计组。

命名法
Pascal命名法:所有单词的首字母都大写,其他字母小写

Camel命名法:除首字母外,其他单词的首字母大写,其他字母小写
缩写
为了避免混淆和保证跨语言交互操作,请遵循有关区缩写的使用的下列规则:

不要将缩写或缩略形式用作标识符名称的组成部分。例如,使用 GetWindow,而不要使用 GetWin。


不要使用计算机领域中未被普遍接受的缩写。


在适当的时候,使用众所周知的缩写替换冗长的词组名称。例如,用 UI 作为 User Interface 缩写,用 OLAP 作为 On-line Analytical Processing 的缩写。

在使用缩写时,对于超过两个字符长度的缩写请使用 Pascal 大小写或 Camel 大小写。但是,应当大写仅有两个字符的缩写,如,System.IO,而不是 System.Io。


对于某些名字中单词都比较长的情况,可以自行写一个缩写名字(名字中的关键字不能缩写),将所有的缩写做一个说明文件,放在同级目录下的开头。
缩进

使用一个“Tab”为每层次缩进(默认4个空格,有的规范也要求2个空格,依要求而定

注释

代码间注释分为单行注释和多行注释


目录
相关文章
|
JavaScript 前端开发 搜索推荐
|
2天前
|
JavaScript 前端开发 Java
驼峰命名规范及其在代码可读性中的重要性
驼峰命名规范及其在代码可读性中的重要性
|
17天前
|
Web App开发 前端开发 定位技术
前端命名规范以及常用命名整理
这是一份关于HTML和CSS编码规范的摘要: - 文件编码统一使用UTF-8。 - 命名遵循语义化,CSS属性书写规范,推荐使用中线命名法(如`hello-world`),避免下划线和驼峰命名。 - 样式应复用,模块化,便于移植。 - 避免使用CSS Hack,优先考虑浏览器兼容性。 - 针对Firefox设计,用IE条件注释做修正。 - 使用英文命名,避免拼音,少用缩写,不以数字开头。 - 常见命名包括页面结构(如`container`、`header`)、导航(`nav`、`subnav`)、功能区域(`logo`、`search`)等,提供了一套常见的ID和Class命名约定。
|
12月前
常见代码命名规范
常见代码命名规范
89 0
|
7月前
|
Go 开发者
详细介绍 Go 语言的命名规范,包括标识符、包名、变量命名、函数命名等
详细介绍 Go 语言的命名规范,包括标识符、包名、变量命名、函数命名等
68 0
详细介绍 Go 语言的命名规范,包括标识符、包名、变量命名、函数命名等
|
8月前
使用 clangd 检查代码命名规范
使用 clangd 检查代码命名规范
|
8月前
|
Unix 开发工具 C++
代码规范:命名规则
【规则 3-2-6】类的数据成员加前缀 m_(表示 member),这样可以避免数据成员与成员函数的参数同名
50 0
|
程序员 C++
编程命名规则
编程命名规则
|
IDE 开发工具
代码重构之神秘命名
聊聊代码中关于命名的重构手段
代码重构之神秘命名

热门文章

最新文章