程序猿的基本素养之注释的规范

前言

实际工程中，像c++这种支持分离编译的高级程序设计语言，往往在不同的文件中定义了不同的类、函数、预定义常量等。

观看较大规模程序的源码时，会对缺乏良好注释的代码充满迷惑。

良好的注释是程序员和阅读代码者之间有效的良好通讯。

注释内容

通常在每个模块（类、函数）开始处有一段序言性注解，简要描述模块的功能、主要算法、接口特点、重要数据和开发过程；程序中间的注解用于解释包含这段代码的必要性。

注释的格式

c++中

有两种注释：

一种是/*  */这种注释继承自c语言，以/*开始，*/结束，称为注释界定符，一般用于全局注释。

全局注释不允许嵌套，即全局注释符号内还有一个全局注释符号;

另一种是//叫做双斜线注释，一般用于半行或单行注释。

Python中

#开头，和c风格的宏定义（#define预定义）很容易搞混（来自一个原python程序猿的感受），c风格还喜欢把#用作开头的预处理功能（#include）使用标准库如（#include <iostream>）告诉编译器该文件使用某库，以及使用其他头文件中的类，还有预处理器中的预处理变量（#ifdef、#ifndef、#endif）以防止重复包含的发生。

""" """这样形式的多行注释。

Tips

1.不用每段代码都有注释

2.清晰明了

3.正确性为首要

点赞收藏加关注，看的过瘾的伙伴关注无神一起学习CS