C/C++常用的文件函数注释格式

最新推荐文章于 2025-03-05 14:03:40 发布
最新推荐文章于 2025-03-05 14:03:40 发布
阅读量5.5k 收藏 9
点赞数 4
分类专栏： 专业 文章标签： 注释
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/zz56z56/article/details/83349997
版权

下面是我经常使用的两个注释格式，一个用于文件信息注释，一个用于函数信息注释，谢谢大家

/***************************************************************



 * @file       程序文件的名称

 * @brief      程序文件的功能

 * @author     作者

 * @version    版本号

 * @date       日期



 **************************************************************/
/***************************************************************



  *  @brief     函数作用

  *  @param     参数   

  *  @note      备注

  *  @Sample usage:     函数的使用方法 



 **************************************************************/

 

C/C++常用预编译指令介绍
dvlinker的技术专栏
09-10 1万+
介绍C/C++中常用的预编译指令。
C/C++ 程序员编程规范之注释（参考）
探索C++编程的奥秘，分享深入的技术见解和实践，旨在激发读者创造力与解决问题的思维。
02-05 4719
编程规范(注释) 注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。 说明性文件（如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等）头部应进行注释. 注释适当列出：版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等，头文件的注释中还应有函数功能简要说明。 源文件头部也应进行注释. 列出：版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修...
个人C++注释规范
weixin_33985679的博客
09-02 171
一、文章来由 好久没写博客了，最近都在做项目，在做项目的过程中遇到多种注释的问题，现在就理清一个注释规范，以后我就按照这个规范来注释~~养成好的注释习惯有助于提高代码的可读性 （注：每个人的习惯不同，可找到自己喜欢的注释风格） 二、具体规范 有的项目可能要求注释占到总行数的额50%。 2.1 源文件头部注释 Ø 列出...
c++的注释格式规范
02-19
1. ##fhd 版权所有 (C), 2010-$YEAR$, ****有限公司 文 件 名 : $FILE$ 版 本 号 : 初稿 作 者 : zhujun/016660 生成日期 : $YEAR$年$MONTH$月$DAY$日 最近修改 : 功能描述 : $end$ $selected$ 函数列表 : 修改历史 : 1.日 期 : $DATE$ $HOUR$:$MINUTE$:$SECOND$ 作 者 : zhujun/016660 修改内容 : 创建文件 *****************************************************************************/
CLion 文件头部注释模板配置
最新发布
m0_58648890的博客
03-05 1034
本文将介绍如何在CLion中配置文件头部注释模板，使其在新建.h和.cpp文件时自动添加标准化的注释。
C++代码注释规范（整理）
08-03 2015
C++代码注释规范（整理） 2010-09-02 16:37 最近一直在给项目代码加注释，因为结项有一项工程性的要求是注释占到总行数的额50%，这几天可苦了我们几个。前几天为了统一项目组的注释规范，专门整理了一份，以后可能也用得着，放着备份下。 1 源文
【规范】C/C++注释格式
bandaoyu的note
12-10 4116
1. 文件 /****************************************************************************************************************** * Copyright (C): 本代码所有版权为ysq所有，任何个人或者组织不得以任何方式复制、转载以挪作他用，否则将构成对ysq的产权知识侵权...
C/C++函数注释格式
嵌入式Stark
02-15 1万+
目录C/C++函数注释格式函数注释格式1函数注释格式2函数注释格式3函数注释格式4函数注释格式5 C/C++函数注释格式 函数注释格式1 //================================================================== //函 数 名： //功能描述： //输入参数： //返 回 值： //作 者： //日 期： //修改记录： //=====================================================
从 C/C++ 代码中删除注释：从 C/C++ 源文件中删除注释。 不做任何预处理。-matlab开发
05-30
使用者可以通过解压并运行这个文件，将C/C++源代码作为输入，然后得到一个注释已被移除的新版本。这个工具可能对于那些需要快速生成没有注释的代码副本，或者需要处理大量源代码的用户来说非常实用。 总之，从C/C++...
vs code C/C++语法高亮配置文件（C/C++ Themes插件）
09-12
vscode配色插件的c/c++语法高亮配置文件，主题插件为C/C++ Themes。 可以对诸如const、enum、typedef别名、结构体引用等语法高亮进行设置，语言本身的关键字自然不用说了，比one dark pro等热门的插件颜色丰富的多。...
VSCode上搭建C/C++开发环境（vscode配置c/c++环境）Windows系统---保姆级教程
热门推荐
2303_79329831的博客
03-01 7万+
关于VSCode上搭建C/C++开发环境的内容，到这里就结束了，这里博主感叹一下，VSCode真的挺强大的，作为一个编辑器，可以通过和编译器链接成为开发环境，将环境配置好的话，在这上面写代码似乎也是个不错的选择。大家有任何疑问，欢迎在评论区中提出，本篇博客有任何问题和错误也欢迎来和博主讨论，真心希望能和大家一起进步。最后，如果本篇博客对你有帮助的话，能不能给博主一个三连啊！
C/C++函数类代码注释详解
fang13155513190的博客
12-07 1344
C++代码示例
Java高级特性之注解
科科然的博客
10-28 484
概念 注解是JDK1.5的新特性，与注释比较类似，不同的是注释是给我们开发人员看的，注解是给代码看的，它是代码层面的解释说明。使用注解：@注解名称，比如我们常见的“@Override”。 作用 ①生成doc文档； ②使用反射对代码进行分析； ③编译检查。 JDK中预定义的一些注解： ①@Override: 检测方法是否是重写父类或父接口的； ②@Deprecated: 标识过时的内容； ③SuppressWarnings:压制警告，一般传入参数all,@SuppressWarnings(.
C++ 头文件格式和函数注释格式
Yours风之恋 ~~~~~
08-13 9232
/******************************************************************* * Copyright(c) 2000-2013 Company Name * All rights reserved. * * 文件名称: * 简要描述: * * 当前版本:2.0 * 作者: * 日期: * 说明: * * 取
C++中注释的方法
qq_37132827的博客
08-20 395
C++注释的方法
分享一个非常好用的C/C++语言函数注释模板
weixin_45106146的博客
05-18 1716
模板使用示例如下： /// <summary> /// 在指定的node结点之后插入新结点，如果node为NULL，表示新结点插在链表第一个结点之前 /// </summary> /// <param name="L">指向链表头结点的指针</param> /// <param name="node">指定在其后插入新结点的结点</param> /// <param name="data">指向要插入结点的数据指针&lt
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值