c++--文件头注释/doxygen

文件头注释

开源项目:

/*** @file    robot_base.cpp* @author  Mr.Wu* @date    2025-05-28* @version 1.0.0* @brief   Robot basic drive to communicate with controller** @copyright Copyright (c) 2025 google.** Licensed under the Apache License, Version 2.0 (the "License");* you may not use this file except in compliance with the License.* You may obtain a copy of the License at**     http://www.apache.org/licenses/LICENSE-2.0** Unless required by applicable law or agreed to in writing, software* distributed under the License is distributed on an "AS IS" BASIS,* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.* See the License for the specific language governing permissions and* limitations under the License.*/

不开源项目

没有许可证:

/*** @file    robot_base.cpp* @author  Mr.Wu* @date    2025-05-28* @version 1.0.0* @brief   Robot basic drive to communicate with controller** @copyright Copyright (c) 2025 google.*/

有许可证:

/*** @file    robot_base.cpp* @author  Mr.Wu* @date    2025-05-28* @version 1.0.0* @brief   Robot basic drive to communicate with controller** @copyright Copyright (c) 2025 google.** 许可证说明*/

(c)的作用

(c)版权符号 © 的文本表示形式。

  • Doxygen 会自动将 (c) 转换为标准版权符号 © 在生成的文档(如 HTML/PDF)中显示。

  • 示例:
    输入 @copyright (c) 2025 google → 输出 © 2025 google

copyright---版权

copyright的作用:

1. 核心作用

用途说明
法律声明明确代码的版权归属方(个人、公司或组织),避免所有权纠纷。
许可证关联与项目中的 LICENSE 文件配合,声明代码的使用条款(如开源协议)。
文档生成Doxygen 会将 @copyright 内容提取到生成的文档中(如 HTML/PDF 的页脚)。
代码溯源帮助后续开发者了解代码的来源和修改历史。

公共许可证

Apache License 2.0

Apache License 2.0(Apache 2.0 许可证)是一种 宽松的开源软件许可证,由 Apache 软件基金会(ASF)制定,广泛用于允许商业使用、修改和分发的开源项目。

所以对于公司项目,不可使用这个许可证。

在 Doxygen 的文件头注释中,指令(如 @file@brief 等)的先后顺序没有严格的技术限制,但为了代码的可读性和一致性,建议遵循一定的逻辑顺序。以下是 Google C++ 风格和常见实践中的推荐顺序:

/*** @file      <文件名>          // 文件标识(通常放最前)* @author    <作者>           // 作者信息* @date      <日期>           // 创建/修改日期* @version   <版本号>         // 版本控制* @brief     <简要描述>       // 核心功能摘要* * @details   <详细描述>       // 可选:扩展说明* @copyright <版权信息>       // 版权声明(通常放最后)*/

对象注释

函数注释

教程

doxygen

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如若转载,请注明出处:http://www.pswp.cn/pingmian/93374.shtml
繁体地址,请注明出处:http://hk.pswp.cn/pingmian/93374.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

【教程】笔记本安装FnOS设置合盖息屏不休眠

重装FnOS好几次了&#xff0c;合盖后屏幕关闭但不休眠的问题每次都要网上找参差不齐的教程&#xff0c;麻烦死了&#xff0c;索性记录一下方便以后复制粘贴。 使用root登录 sudo -i修改系统配置文件编辑logind.conf文件&#xff1a; 打开终端&#xff0c;输入以下命令以编辑log…

深入解析 Monkey OCR:本地化、多语言文本识别的利器与实践指南

在信息爆炸的时代&#xff0c;从图片、扫描文档中高效提取结构化文本的需求日益迫切。OCR&#xff08;光学字符识别&#xff09;技术成为解决这一问题的核心工具。尽管市面上有 Abbyy FineReader、Adobe Acrobat 等商业巨头&#xff0c;以及 Tesseract、PaddleOCR 等开源方案&a…

动态规划法 - 53. 最大子数组和

什么是动态规划法&#xff1f; 简单说&#xff0c;动态规划&#xff08;Dynamic Programming&#xff0c;简称 DP&#xff09; 是一种**「把复杂问题拆解成小问题&#xff0c;通过解决小问题来解决大问题」**的方法。 核心思路有两个&#xff1a; 1.拆分问题&#xff1a;把原问…

STM32CUBEMX配置stm32工程

1.新建工程2.选择芯片3.配置各种片上外设和时钟4.创建工程5.根据文件内容进行修改工程注意&#xff1a;最好根据工程规范来做&#xff0c;因为有时我们需要更改配置并重新生成&#xff0c;如果不按规范来会导致部分代码会被系统清除&#xff0c;在工程中中有很多成对的BEGIN和E…

Day07 缓存商品 购物车

缓存菜品问题说明用户端小程序展示的菜品数据都是通过查询数据库获得&#xff0c;如果用户端访问量比较大&#xff0c;数据库访问压力随之增大。结果&#xff1a;系统响应慢&#xff0c;用户体验差实现思路通过 Redis 来缓存菜品数据&#xff0c;减少数据库查询操作。缓存逻辑分…

Jenkins(集群与流水线配置)

Jenkins&#xff08;集群与流水线配置&#xff09; Jenkins集群 集群化构建可以提升构建效率&#xff0c;也可以并发在多台机器上执行构建。 安装前提&#xff1a;内存至少512MB、Java 17 以上、Maven环境、Git环境 配置集群步骤 配置节点菜单新建节点查看节点配置状态 新建完节…

深入剖析ROS参数服务器通信机制 ——共享全局数据的“云端仓库”实现原理

​1. 核心概念&#xff1a;分布式数据共享容器​ ​定位​&#xff1a;ROS参数服务器&#xff08;Parameter Server&#xff09;是ROS架构中的全局共享存储系统&#xff0c;相当于机器人的“云端仓库”。 ​作用​&#xff1a; 存储多节点共享的静态配置参数&#xff08;如机器…

21.AlexNet

虽然LeNet在手写数字识别上取得了不错的结果&#xff0c;但是他在对于更大的数据集效果就十分有限。 一方面&#xff0c;对于更大尺寸的图像效果有限 另一方面&#xff0c;对于更多分类的任务效果有限 自LeNet后的十几年&#xff0c;计算机视觉领域步入寒冬&#xff0c;神经网络…

Shell脚本-条件判断相关参数

一、前言在 Shell 脚本编程中&#xff0c;条件判断 是实现流程控制的核心机制之一。无论是判断文件是否存在、字符串是否相等&#xff0c;还是数值大小比较&#xff0c;都离不开条件判断语句。本文将带你全面掌握 Shell 脚本中与条件判断相关的参数和语法&#xff0c;包括&…

何为“低空经济”?

低空经济&#xff08;Low-Altitude Economy&#xff09;是指以1000米以下空域&#xff08;部分场景可延伸至3000米&#xff09;为核心&#xff0c;以无人机&#xff08;UAV&#xff09;、电动垂直起降飞行器&#xff08;eVTOL&#xff09;、直升机、通航飞机等航空器为载体&…

线性代数 | 直观理解一些概念

注&#xff1a;本文为 “线性代数 直观理解概念” 相关合辑。 英文引文&#xff0c;机翻未校。 中文引文&#xff0c;略作重排。 如有内容异常&#xff0c;请看原文。 直观理解线性代数的一些概念 2015-03-06 Updated: 2015-05-09 本文介绍矩阵的一些相关概念的直观理解&…

Spring AI 集成阿里云百炼平台

Spring AI 集成阿里云百炼平台 创建API key 在阿里云百炼平台创建API key设置系统变量。阿里云百炼 api key 创建 API 参考 官方API地址&#xff1a;https://bailian.console.aliyun.com &#xff08;1&#xff09;在阿里云百炼控制台&#xff0c;选择API参考菜单。 API…

Codeforces Round 859 (Div. 4) A - D + F - G2 题解

Codeforces Round 859 (Div. 4) A - D F - G2 题解A. Plus or Minus&#xff08;800 分难度&#xff09; 思路&#xff1a; 直接 if - else 判断。 参考代码&#xff1a; #include<bits/stdc.h> using namespace std; void solve(){int a, b, c;cin >> a >&g…

【Java web】Servlet 详解

一、什么是 Servlet&#xff1f;—— 你不知道的 "网页服务员"想象你走进一家网红书店&#xff08;比如 "在线 Java 书店"&#xff09;&#xff0c;想买一本《Java 编程思想》。你告诉前台服务员你的需求&#xff0c;服务员去仓库找书、包装、收款&#xf…

数据库Microsoft Access、SQL Server和SQLite三者对比及数据库的选型建议

SQLite本质是代码库&#xff0c;Access是单文件桌面DB&#xff0c;SQL Server是正经的C/S架构数据库。这就像比较自行车、家用轿车和卡车&#xff0c;完全不同的设计目标。 核心区别对比表特性Microsoft AccessSQL ServerSQLite类型桌面DBMS (文件型)客户端/服务器 RDBMS嵌入式…

【C++】默认构造函数,参数化构造函数,拷贝构造函数,拷贝赋值运算符, 移动构造函数 ,移动赋值运算符

1. 默认构造函数 (Default Constructor) 作用&#xff1a; 无参创建对象 签名&#xff1a; ClassName() 特点&#xff1a; ①无参数或所有参数都有默认值 ②若未声明任何构造函数&#xff0c;编译器自动生成&#xff08;空实现&#xff09; ③用于容器默认初始化&#xff08;如…

办公效率提升指南:完成重复任务自动化

手动操作容易出错&#xff0c;尤其是在处理大量数据或复杂文档时。它将PDF转换、Word处理、Excel操作、OCR识别等高频功能融为一体&#xff0c;界面清爽无冗余&#xff0c;零广告打扰&#xff0c;专注提升工作效率。它内置七大核心模块&#xff1a;自动任务、系统工具、文件处理…

数字炼金术:当API工作流遇见AI客服—点石成金的智能革命!

目录 引言 一、蓝耘元生代MaaS平台概述 1.1 蓝耘平台的API服务 1.2 蓝耘平台的优势 二、初识蓝耘元生代MaaS平台—带你深度体验 2.1 从零开始——平台注册与环境搭建 2.2 蓝耘平台的优势在哪里&#xff1f; 三、API工作流调用技巧与实践 3.1 API工作流设计与调用流程 …

HackMyVM-Uvalde

目录信息搜集漏洞利用权限提升信息搜集 主机发现 ┌──(kali㉿kali)-[~] └─$ nmap -sn 192.168.21.0/24 Starting Nmap 7.95 ( https://nmap.org ) at 2025-08-16 01:10 EDT Nmap scan report for dev.medusa.hmv (192.168.21.6) Host is up (0.00015s latency). MAC Addr…

「Java EE开发指南」如何使用MyEclipse中的Web Fragment项目?

开发者可以通过使用Web Fragment项目模块化应用程序部署描述符&#xff0c;本文提供如何使用它们的必要信息。 该特性在MyEclipse中可用。 MyEclipse v2025.1离线版下载 通过使用Web Fragment项目&#xff0c;您的Web应用程序部署描述符可以模块化&#xff0c;就像能够模块化…