C语言注释风格
注释风格
一、前言
注释是源码程序中非常重要的一部分,一般情况下,源程序有效注释量必须在20%以上。
注释的原则是有助于对程序的阅读理解,所以注释语言必须准确、易懂、简洁,注释不宜太多也不能太少,注释的内容要清楚、明了、含义准确,防止注释二义性,该加的地方一定要加,但不必要的地方一定不要加。
注释风格很多,这里只是对于我的代码进行规范。
二、风格
1、文件注释
FileName
文件名Description
模块描述Change Logs
变更日志
/*
* Copyright (C), 1988-1999, Xxxxxx Tech. Co., Ltd.
* FileName: xxx
* Description: balabalabalabalabalabalabalabalabala
balabalabalabalabalabalabalabalabalabalabalabala
* Change Logs:
|Date |Author |Notes |version
|2010-03-22 |XXX |XXX |1.0.0
*/
2、函数注释
Function
函数名称Description
函数描述Calls
调用的函数清单Input
输入参数说明,包括每个参数的作用、取值说明及参数间关系Output
输出参数的说明Return
函数返回值的说明Others
其他说明
/*
* Function:
* Description:
* Calls:
* Input:
* Input:
* Output:
* Return:
* Others:
*/
3、宏定义注释
@define
定义块概述No error
定义值说明
/* @define xxx */
#define XXX_ERROR_OK 0 /* No error */
#define XXX_ERROR_INVALID_TOKEN 1 /* Invalid token */
#define XXX_ERROR_EXPECT_TYPE 2 /* Expect a type */
4、结构体注释
@struct
结构体概述next item
结构体元素说明
/* @struct xxx */
struct xxx_syscall_item
{
struct xxx_syscall_item* next; /* 下一个item */
struct xxx_syscall syscall; /* syscall */
};
5、全局变量
全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。
Description
作用描述Scope
作用域Range
取值范围Notice
注意事项Others
其他说明
/* @variable temp */
/* Scope: 存储温度值 */
/* Range: -128 - 127 */
/* Notice: xxxxx */
/* Others: xxxxx */
extern char temp = 0;
C语言注释风格的更多相关文章
- C语言程序注释风格
良好编程习惯的养成对于一个程序员的发展非常重要,而注释对于一份程序来讲又是一个必不可少的组成部分,今天来研究一下C语言程序的注释风格. 注释是源码程序中非常重要的一部分,一般情况下,源程序有效注释量必 ...
- go语言注释
Go语言注释实例代码教程 - Go支持C语言风格的/* */块注释,也支持C++风格的//行注释. 当然,行注释更通用,块注释主要用于针对包的详细说明或者屏蔽大块的代码. 每个包都应有一个包注解,即 ...
- R 语言编码风格指南
R 语言是一门主要用于统计计算和绘图的高级编程语言.这份 R 语言编码风格指南旨在让我们的 R代码更容易阅读.分享和检查.以下规则系与 Google 的 R 用户群体协同设计而成. 概要: R编码风格 ...
- 来自 Google 的 R 语言编码风格指南
来自 Google 的 R 语言编码风格指南R 语言是一门主要用于统计计算和绘图的高级编程语言. 这份 R 语言编码风格指南旨在让我们的 R 代码更容易阅读.分享和检查. 以下规则系与 Google ...
- 如何在Eclipse中如何自动添加注释和自定义注释风格
1. 如何自动添加注释 可通过如下三种方法自动添加注释: (1)输入“/**”并回车. (2)用快捷键 Alt+Shift+J(先选中某个方法.类名或变量名). (3)在右键菜单中选择“Source ...
- C#语言注释详解
C#语言注释有三种形式 C#语言注释有三种形式 第一种是多行注释: /* */ 例如: /* int a=1; int b=2; int c=3; */// 第二种是单行注释: 例如: // int ...
- IDEA修改XML注释风格
作为一个强迫症患者,每次想在xml文件用快捷键注释的时候,它自动生成的注释一直都是这样的:这令我非常难受,于是每次我都要把光标移到前面,然后再Tab以下,让它变成这样可是每次都这样,好麻烦啊,如果自己 ...
- 个人c语言编程风格总结
总结一下我个人的编程风格及这样做的原因吧,其实是为了给实验室写一个统一的C语言编程规范才写的.首先声明,我下面提到的编程规范,是自己给自己定的,不是c语言里面规定的. 一件事情,做成和做好中间可能隔了 ...
- c语言编程风格
关于c语言的编程风格,不同的书上有不同的推荐,不同的公司有不同的要求.这里,做了一下基本规范说明. 1.变量定义 在定义变量时,前缀使用变量的类型,之后使用表现变量用途的英文单词或单词缩写,且每个单词 ...
随机推荐
- SQL Server Compact 3.5环境部署<转>
通过使用 Microsoft Visual Studio 开发环境,可以开发使用 SQL Server Compact 3.5 的应用程序.Visual Studio 是开发和部署使用 SQL Ser ...
- CTF-代码审计(3)..实验吧——你真的会PHP吗
连接:http://ctf5.shiyanbar.com/web/PHP/index.php 根据题目应该就是代码审计得题,进去就是 日常工具扫一下,御剑和dirsearch.py 无果 抓包,发现返 ...
- bugku insertsql
题目链接 0X00题目给出的PHP代码 error_reporting(0); function getIp(){ $ip = ''; if(isset($_SERVER['HTTP_X_FORWAR ...
- Python在Linux环境中安装Thrift
1.文件下载:thrift-0.11.0.tar.gz 个人网盘下载:链接:https://pan.baidu.com/s/1MXgx8LuN4wk7ssVUD9Wzaw 提取码:xw85 2. ...
- nbu虚拟机恢复样例(之后补图)
9.2.1进入Backup,Archive,and Restore管理器 9.2.2选择客户端和策略类型 9.2.3选择恢复的虚拟机 9.2.4恢复虚拟机到不同目录 9.2.5更改虚拟机名称和存储 因 ...
- Java期末复习——主观题
JDK 和 JRE 有什么区别? JDK:Java Development Kit 的简称,java 开发工具包,提供了 java 的开发环境和运行环境. JRE:Java Runtime Envir ...
- SpringBoot——IDEA使用 Spring Initializer快速创建项目【四】
前言 使用Spring Initializer快速创建项目 步骤 首先肯定是打开我们的IDEA的编辑器呀~ 创建项目 File -> New -> Project Spring Initi ...
- postman常用功能汇总(基础必备)
下载安装 下载地址:https://www.getpostman.com/downloads/ 安装:略 接口测试详解 包含get,post(k-v,json,上传文件,cookie) 参考:http ...
- ubuntu16.04深度学习环境配置
https://www.lizenghai.com/archives/14651.html https://blog.csdn.net/qq_40936141/article/details/8119 ...
- JavaScript词法作用域—你不知道的JavaScript上卷读书笔记(一)
前段时间在每天往返的地铁上抽空将 <你不知道的JavaScript(上卷)>读了一遍,这本书很多部分写的很是精妙,对于接触前端时间不太久的人来说,就好像是叩开了JavaScript的另一扇 ...