编程命名规范以及函数文件注释

2024-01-21 19:18:22

文章目录

1编程命名法
2 函数注释
3 文件注释

1编程命名法

1.1 驼峰命名法

1.1.1 小驼峰法

除第一个单词之外，其他单词首字母大写（常用于变量）

int myStudentNumber

1.1.2 大驼峰法（又叫帕斯卡命名法）

与小驼峰式命名法的最大区别在于，每个单词的第一个字母都要大写。（常用于类名，函数名，属性，命名空间）

class StudentFamily

1.2. 匈牙利命名法

变量名＝属性＋类型＋对象描述，这样做的好处是使程序员第一眼看到变量时就对变量的类型和其它属性有直观的了解。

1.2.1 匈牙利命名法 - 属性

全局变量 g_
常量 c_
成员变量 m_
静态变量 s_

1.2.2 匈牙利命名法 - 类型

a      数组（Array）
b      布尔值（Boolean）
by     字节（Byte）
c      有符号字符（Char）
cb     无符号字符（Char Byte，并没有神马人用的）
cr     颜色参考值（Color Ref）
cx,cy  坐标差（长度 Short Int）
dw     双字（Double Word）
fn     函数（Function）
h      Handle（句柄）
i      整形（Int）
l      长整型（Long Int）
lp     长指针（Long Pointer）
m_     类成员（Class Member）
n      短整型（Short Int）
np     近程指针（Near Pointer）
p      指针（Pointer）
s      字符串（String）
sz     以 Null 做结尾的字符串型（String with Zero End）
w      字（Word）

1.2.3 匈牙利命名法 - 描述

最大 Max
最小 Min
初始化 Init
临时变量 T（或Temp）
源对象 Src
目的对象 Dest

1.3 下划线命名法

所有字母均小写，每个单词间以下划线分割

int student_number

1.4. 命名实例

　　m_iMyData 是一个匈牙利命名法,m_表示它是成员变量，小写的i说明了它是个整型,后面的和帕斯卡命名相同,指示了该变量的用途

　　myData 是一个骆驼命名法,它第一个单词的第一个字母小写,后面的单词首字母大写,看起来像一个骆驼

　　MyData 就是一个帕斯卡命名的示例

　　my_data 是一个下划线命名的示例

2 函数注释

/**************************/
//功能
//参数
//返回值
//主要思想
//调用
//日期
/*************************/

3 文件注释

/***************************/
//工程：文件所在工程
//作者：
//描述：主要功能
//主要函数：
//版本/日期
/**************************/

参考：
https://blog.csdn.net/ZCF1002797280/article/details/51495229
https://blog.csdn.net/u013539952/article/details/106254586/
https://zhuanlan.zhihu.com/p/89909623
https://blog.csdn.net/u013539952/article/details/106254586/