当前位置：网站首页 > 技术文章 > 正文

C语言代码注释参考

myzbx 2025-01-07 14:27 19 浏览

简述

该参考是基于Doxygen注释规范进行简单归纳，可以适当根据自己的需求进行约定。

Doxygen可以从一套归档源文件开始，生成HTML格式的在线类浏览器，或离线的LATEX、RTF参考手册。简单来说就是一个程序的文件产生工具，可将程序中的特定注释转换成为说明文件。

注释规范内容

1. 简单注释

（1）单行注释

///

（2）多行注释

/**

2. 文件注释

/**
*@file     文件名
*@brief    简介
*@datails  细节
*@mainpage 工程概览
*@autor    作者
*@email    邮箱
*@version  版本号
*@date     年-月-日
*@license  版权
*/

3. 常量/变量注释

（1）代码前注释

///注释

变量/常量定义

（2）代码后注释

变量/常量定义 ///<注释

4. 函数注释

下面是函数的详细注释，可根据实际情况增减相关条目。

/**
*@brief     函数简介
*@datail    详细说明
*
*@param     形参 参数说明
*@param     形参 参数说明
*@return    返回说明
*@retval    返回值说明
*@note      注解
*@attention 注意
*@warning   警告
*@exception异常
*/

5. 其他内容注释

命令生成字段名说明

@see 参考

@class 应用类用于文档生成连接

@var 引用变量用于文档生成连接

@enum 引用枚举用于文档生成连接

@code 代码块开始与@endcode成对使用

@endcode 代码块接收与@code成对使用

@bug 缺陷

@todo

@example 使用例子说明

@remarks 备注说明

@pre 函数前置条件

@deprecated 函数过时说明

HTML 参考手册

上一篇：js-ES6 完全使用手册
下一篇：IIS建站操作手册(基础教程)

相关推荐

炫酷的计时器效果Canvas绘图与动画: -----------------------------------------华丽的分割线-----------------------------------------------------...

康托尔集合的绘制及其Python绘制（康托尔集合论的概括原则是什么）: 康托尔三分集（Cantorternaryset）是数学中一个著名的分形例子，由德国数学家格奥尔格·康托尔在1883年引入。它通过不断去掉线段的中间三分之一部分，重复这个过程得到的一个分形集合。康托...

一文带你搞懂JS实现压缩图片（js 压缩图片）: 作者：wuwhs转发链接：https://segmentfault.com/a/1190000023486410前言公司的移动端业务需要在用户上传图片是由前端压缩图片大小，再上传到服务器，这样可以减...

数据可视化—Echarts图表应用（数据可视化图表类型）: ECharts是一款由百度前端技术部开发的，基于Javascript的数据可视化图表库，提供直观，生动，可交互，可个性化定制的数据可视化图表。使用JavaScript实现开源的可视化库，可以流畅的...

ThreeJS中三维世界坐标转换成二维屏幕坐标: Threejs全称是“Javascript3Dlibrary”。WebGL则是openGL在浏览器上的一个实现。Threejs对WebGL进行了封装，让前端开发人员在不需要掌握很多数学知识和绘图知...

鸿蒙开源第三方件组件——加载动画库: 前言基于安卓平台的加载动画库AVLoadingIndicatorView（https://github.com/81813780/AVLoadingIndicatorView），实现了鸿蒙化迁移和重构...

canvas实现下雪背景图（canvas绘制背景图）: canvas下雪背景html+css+js实现：1.定义标签：<h1>北极光之夜。</h1><divclass="bg"></...

用canvas画简单的“我的世界”人物头像: 前言：花了4天半终于看完了《HeadFirstHTML5》，这本书的学习给我最大的感受就是，自己知识的浅薄，还有非常多非常棒的技术在等着我呢。[熊本表情]扶朕起来，朕还能学！H5新增标签里面最喜欢...

Manim-基础图形之点（什么叫图形基点）: 制作数学演示视频时需要用到各类的集合图形，manim中内置了一些列的图形，本篇就从最简单的点讲起。点作为manim中最简单图形，也是其他所有图形的基，所有图形的绘制都是靠点来定位。manim中的点主...

一起学 WebGL:坐标系（坐标系格式）: 大家好，我是前端西瓜哥，今天我们来学习WebGL。WebGL的世界坐标系是三维的。默认使用笛卡尔坐标系的右手坐标系，满足右手定则，即x轴向右，y轴向上，z轴向着观察者，原点位于画布中心。然...

漫画欣赏 - 聖鬥士星矢 THE.LOST.CANVAS 冥王神話 24: 《圣斗士星矢THELOSTCANVAS冥王神话》改编自车田正美原作的漫画《圣斗士星矢》，由车田正美原作、手代木史织作画。其外传《圣斗士星矢THELOSTCANVAS冥王神话外传》则在《...

漫画欣赏 - 聖鬥士星矢 THE.LOST.CANVAS 冥王神話 25 - 完结篇: 《圣斗士星矢THELOSTCANVAS冥王神话》改编自车田正美原作的漫画《圣斗士星矢》，由车田正美原作、手代木史织作画。其外传《圣斗士星矢THELOSTCANVAS冥王神话外传》则在《...

Eric Fischl 名画录（eric tucker画家）: 艾瑞克费舍尔(EricFischl，1948——)，是美国新表现主义画家，当代国际画坛一位十分活跃的人物，在国际上享有很高的知名度。作为20世纪美国第6次经济衰退时期本土第一个伟大画家艾瑞克·费舍尔...

canvas绘画板的实现（canvas画布）: 新项目有一个需求：客户需要在订单确认的时候签名。第一反应就是用html的canvas实现，同事一起商量了下，canvas有三个制约：canvas必须要用鼠标，签名会很难看；手机端webapp怎么实现...

Python程序开发之简单小程序实例(9)利用Canvas绘制图形和文字: Python程序开发之简单小程序实例（9）利用Canvas绘制图形和文字一、项目功能利用Tkinter组件中的Canvas绘制图形和文字。二、项目分析要在窗体中绘制图形和文字，需先导入Tkinter组...

一周热门

最近发表

首页
收录
顶部