【其他】文件头注释、函数头注释、全局变量注释规范

文件头注释：

/**
* @file （本文件的文件名eg：mib.h）
* @brief （本文件实现的功能的简述）
* @version 1.1 （版本声明）
* @author （作者，eg：张三）
* @date （文件创建日期，eg：2010年12月15日）
*/

函数头注释：

/**
*@ Description:向接收方发送SET请求
* @param req - 指向整个SNMP SET 请求报文.
* @param ind - 需要处理的subrequest 索引.
* @return 成功：SNMP_ERROR_SUCCESS，失败：SNMP_ERROR_COMITFAIL
*/
Int commit_set_request(Request *req, int ind);

全局变量注释：

/** 模拟的Agent MIB */
agentpp_simulation_mib * g_agtSimMib;

函数头注释建议写到声明处。并非所有函数都必须写注释，建议针对这样的函数写注释：重要的、复杂的函数，提供外部使用的接口函数。

【其他】文件头注释、函数头注释、全局变量注释规范相关推荐

【reverse】buu-CrackRTF——提取PE中的resource、rtf的固定文件头
文章目录依赖正文第一关代码第二关提取exe中的资源 RTF的固定文件头总结完整代码参考资料依赖 IDA7.7 python的pefile库作者:hans774882968以及ha ...
bmp文件头_「正点原子FPGA连载」第十九章SD卡读BMP图片LCD显示
1)摘自[正点原子]领航者 ZYNQ 之嵌入式开发指南 2)实验平台:正点原子领航者ZYNQ开发板 3)平台购买地址:https://item.taobao.com/item.htm?&id= ...
位图（BMP）文件头格式及数据分析
由于BMP文件有诸多格式,这里只以256色彩色位图为例来分析一下. 这个图是我自己用画图板做的,如下. 图1 BMP图由于这里限制上传BMP文件,所以这个是JPG的.我的原始的BMP文件大小是200 ...
8位bmp 原始裸格式数据，需要加上文件头+位图信息头+调色板+位图数据才是bmp图像
byte[ ]进行处理,添加bmp的文件头+位图信息头+调色板+位图数据.保存8位bmp,如果是调色板有问题,位图会是纯白,纯黑等,无法显示正常图像.好了,代码奉上. package com.idf ...
FFmpeg源码分析：写媒体文件头avformat_write_header()
FFmpeg在libavformat模块提供mux封装视频的API,包括avformat_write_header()写文件头.av_write_frame()写音视频帧.av_write_trail ...
Visual Studio+VAssistX自动添加注释，函数头注释，文件头注释
在VAssistX中为C++提供了比较规范注释模板,用这个注释模板为编写的C++代码添加注释是很便捷的选择,操作起来也很简单,具体方法和步骤如下: 1.增加函数头注释之后注释模板中编辑自己需要的注释 ...
8 pycharm 快捷键_Pycharm自动添加文件头注释和函数注释参数
Pycharm应该是学python必用的编辑器了,关于它的使用之前已经写过几篇文章,今天再给大家继续介绍两个pycharm的小技巧,希望对大家有用. 1.自动添加文件头注释文件头模板设置路径 Set ...
Pycharm自动添加文件头注释和函数注释参数
Pycharm应该是学python必用的编辑器了,关于它的使用之前已经写过几篇文章,今天再给大家继续介绍两个pycharm的小技巧,希望对大家有用. 1.自动添加文件头注释文件头模板设置路径 Set ...
Vim 自动文件头注释与模板定义
Vim 自动文件头注释与模板定义在vim的配置文件.vimrc添加一些配置可以实现创建新文件时自动添加文件头注释,输入特定命令可以生成模板. 使用方法插入模式输入模式输入seqlogic[Ente ...

【其他】文件头注释、函数头注释、全局变量注释规范

【其他】文件头注释、函数头注释、全局变量注释规范相关推荐

最新文章

热门文章