命名的基本原则

您所在的位置:网站首页 品牌命名最基本原则是 命名的基本原则

命名的基本原则

2024-07-14 06:56| 来源: 网络整理| 查看: 265

2 命名的基本原则

(1)标识符的命名要清晰、明了,有明确含义,同时使用完整的单词或大家基本可以理解的缩写,避免使人产生误解——尽量采用采用英文单词或全部中文全拼表示,若出现英文单词和中文混合定义时,使用连字符“_”将英文与中文割开。较短的单词可通过去掉“元音”形成缩写;较长的单词可取单词的头几个字母形成缩写;一些单词有大家公认的缩写。例如:temp->tmp、flag->标志寄存器、statistic->stat、increment->inc、message->msg等缩写能够被大家基本认可。

(2)命名中若使用特殊约定或缩写,则要有注释说明。应该在源文件的开始之处,对文件中所使用的缩写或约定,特别是特殊的缩写,进行必要的注释说

(3)对于变量命名,禁止取单个字符(如i 、j 、k… ),建议除了要有具体含义外,还能表明其变量类型、数据类型等,但i 、j 、k 作局部循环变量是允许的。变量,尤其是局部变量,如果用单个字符表示,很容易敲错(如i写成j),而编译时又检查不出来,有可能为了这个小小的错误而花费大量的查错时间。

(4)除非必要,不要用数字或较奇怪的字符来定义标识符。

(5)命名规范必须与所使用的系统风格保持一致,并在同一项目中统一。

(6)在同一软件产品内,应规划好接口部分标识符(变量、结构、函数及常量)的命名,防止编译、链接时产生冲突。对接口部分的标识符应该有更严格限制,防止冲突。如可规定接口部分的变量与常量之前加上“模块”标识等。

(7)用正确的反义词组命名具有互斥意义的变量或函数等。

下面是一些在软件中常用的反义词组。 ass/remove begin/end create/destroy insert/delete first/last get/release increment/decrement put/get add / delete lock / unlock open / close min / max old / new start /stop next / previous source /target show / hide send /receive source / destination cut /paste up / down

试列: int min_sum; int max_sum; int add_user(BYTEuser_name); int delete_user(BYTEuser_name); (8)除了编译开关/ 头文件等特殊应用,应避免使用EXAMPLE_TEST 之类以下划线开始和结尾的定义。



【本文地址】


今日新闻


推荐新闻


CopyRight 2018-2019 办公设备维修网 版权所有 豫ICP备15022753号-3