首页 > 编程语言 >C++/C 规范:命名规范和注释

C++/C 规范:命名规范和注释

时间:2022-10-25 11:23:35浏览次数:56  
标签:sample 变量 int 规范 C++ 注释 命名 函数

变量

变量命名 里面只能是名词,不能有动词

  1. 宏:全部大写,如:FRAME_SIZE
  2. 变量:驼峰命名规则,首个单词小写,如:myFrameSize
  3. 全局变量:在变量前后添加字母 G,如:myFrameSizeG

函数

尽量利用动词表达函数功能

  1. 利用下划线连接各单词,如 av_audio_fifo_alloc()

  1. 类名 采用驼峰命名规则,但首单词首字母大写,如:MyFrame
  2. 类函数 命名规则 与 函数 类似

注释

声明注释 /**/
  • 变量/函数/类 声明的注释采用如下形式
/**
* 注释本体
*/
int myFrameSize;
  • 如果是函数,尽量在注释本体说明 函数功能、输入、输出含义,如:
/**
 * Allocate an AVAudioFifo.
 *
 * @param sample_fmt  sample format
 * @param channels    number of channels
 * @param nb_samples  initial allocation size, in samples
 * @return            newly allocated AVAudioFifo, or NULL on error
 */
AVAudioFifo *av_audio_fifo_alloc(enum AVSampleFormat sample_fmt, int channels,
                                 int nb_samples);
宏尾端的注释用 /**/
内嵌注释 //

标签:sample,变量,int,规范,C++,注释,命名,函数
From: https://www.cnblogs.com/zjacky/p/16790857.html

相关文章

  • C++ 不知树系列之初识树(树的邻接矩阵、双亲孩子表示法……)
    1.前言树是一种很重要的数据结构,最初对数据结构的定义就是指对树和图的研究,后来才广义化了数据结构这个概念。从而可看出树和图在数结构这一研究领域的重要性。树和图重......
  • C++ Multi Thread
    自定义LockclassReadLock{public:ReadLock(ZoneFile*zfile):zfile_(zfile){zfile_->writer_mtx_.lock();zfile_->readers_++;zfil......
  • C++ Class
    类class与struct为什么c++里面经常定义struct?利用struct默认访问修饰符为public的特性,属性static成员#include<iostream>usingstd::cout;usingstd::endl;clas......
  • C++_函数指针/回调函数/std::function/std::bind
    类成员函数指针指向类中的非静态成员函数#include<iostream>#include<functional>#include<algorithm>#include<vector>usingnamespacestd;//函数指针指向一......
  • C++ 逻辑运算符
    //逻辑运算符inta=5;intb=20;if(a&&b){cout<<"Line1-条件为真"<<endl;}if(a||b......
  • C++ 关系运算符
    //关系运算符inta=21;intb=10;intc;if(a==b){cout<<"Line1-a等于b"<<endl;......
  • C++ 算术运算符号
    //算术运算符号inta=10;intb=2;intc=3;//+加法cout<<"a+b="<<a+b<<endl;//-减法cout<<"a-b=......
  • 实验3 数组、指针与现代C++标准库
    实验任务5:info.hpp:#include<iostream>#include<string>usingnamespacestd;classinfo{public:info(stringni,stringco,stringci,intn);voidpri......
  • 《Programming Abstractions in C++》总结目录
     1.C++基础 C++程序结构变量数据类型表达式语句 2.C++抽象函数库接口字符串类流类集合类类的设计 3.算法递归回溯排序时间复杂度 4......
  • c++执行期语义
    obejctconstructionanddestruction​ 一般而言,constructor和destructor的安插都如预期那样:{Pointpoint;//point.Point::Point()安插于此...//p......