【软件编译规范】软件代码前缀标准注释

原创 已于 2023-10-14 17:04:27 修改 · 421 阅读 · 1 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#c语言 #51单片机 #stm32

于 2022-11-07 16:51:20 首次发布
本文详细介绍了代码注释中常见的规范元素，如简介、参数、返回类型、异常、作者、日期及版本等，并解释了它们在软件开发过程中的重要性和用途。

@brief  @param  @return @author @date @version是代码书写的一种规范

@brief  ：简介，简单介绍函数作用
@param  ：介绍函数参数
@return：函数返回类型说明
@exception NSException 可能抛出的异常.
@author zhangsan：  作者
@date 2023-07-27 22:30:00 ：时间
@version 1.0 ：版本  
@property ：属性介绍

【软件开发规范一】《Java开发规范》
商务合作|问题讨论|交流学习 请联系作者微信，加微信请务必注明来意，博客主页有联系方式
07-18 3327
此文档说明书供开发部全体成员阅读。1.【强制】不允许任何魔法值（即未经预先定义的常量）直接出现在代码中。反例2.【强制】long或者Long初始赋值时，使用大写的L，不能是小写的l，小写容易跟数字1混淆，造成误解。说明写的是数字的21，还是Long型的2?3.【推荐】不要使用一个常量类维护所有常量，按常量功能进行归类，分开维护。说明大而全的常量类，非得使用查找功能才能定位到修改的常量，不利于理解和维护。正例缓存相关常量放在类CacheConsts下；...
C++(Qt)软件调试---编译器及编译参数学习（4）
mahuifa的博客
04-01 3609
在学习C++软件调试之前，了解编译器参数是非常重要的。因为编译器参数决定了程序编译的行为，包括编译器如何处理源代码、如何生成目标代码、如何链接库文件等等。 学习编译器参数可以帮助我们更好地理解和掌握C++程序的编译过程，更好地解决编译和调试过程中的问题，提高程序的性能和可维护性。
常见编程软件注释 @brief @param @return
热门推荐
qq_40305944的博客
03-27 10万+
/** * @brief @param @return @author @date @version是代码书写的一种规范 * @brief ：简介，简单介绍函数作用 * @param ：介绍函数参数 * @return：函数返回类型说明 * @exception NSException 可能抛出的异常. * @author zhangsan： 作者 * @date 2011-07-27 22:30:00 ：时间 * @version 1.0 ：版本 * @property ...
C++ 等的常见软件注释 @brief @param @return
是鲤鱼啊
09-24 1万+
@brief：简介，简单介绍函数作用 @param：介绍函数参数 @return：函数返回类型说明 @exception NSException 可能抛出的异常. @author zhangsan：作者 @date 2011-07-27 22:30:00 ：时间 @version 1.0 ：版本 @property ：属性介绍 如 /** * @brief Create new QToolButton * * @param name Name of...
关于jdk的注解@SuppressWarnings详解
开发笔记
03-01 294
@SuppressWarnings J2SE 提供的一个批注或者注解。该批注的作用是给编译器一条指令，告诉它对被批注的代码元素内部的某些警告保持静默，即忽略这些警告信息。 在平常的编码过程中，我们经常使用到的是unchecked,serial这些。 @SuppressWarnings()中可传入一个字符串数组，数组中列出需要忽略的情况。 如果传入多种情况，这几种情况的处理同时执行。例如： ...
软件编码规范（代码编辑、编译、审查 ）
Summer的博客
06-25 783
//摘抄自华为软件编写规范 1、某些语句经编译后产生告警，但如果你认为它是正确的，那么应通过某种手段去掉告警信息 说明：在 Borland C/C++中，可用“#pragma warn”来关掉或打开某些告警。 示例： #pragma warn -rvl // 关闭告警 int examples_fun( void ) { // 程序，但无 return 语句。
软件文档、注释规范
智障儿童欢乐多
06-25 635
软件文档 需求 必要的功能 可选的功能 设计方案 可能选取的各种方案 实现说明 架构说明, 解耦, 模块说明 网络接口 数据库设计说明 重要的类,方法 测试 ...
软件编码规范
01-18
### 软件编码规范——C语言代码规范详解 #### 1. 排版 - **规则1-1**：程序块要采用缩进风格编写，缩进的空格数为4个。推荐使用一个TAB键来表示。这种方式有助于保持代码的一致性和可读性。 - **规则1-2**：为了...
【软件开发规范四】《应用系统安全编码规范》
商务合作|问题讨论|交流学习 请联系作者微信，加微信请务必注明来意，博客主页有联系方式
07-18 1387
为落实《信息安全策略》的要求，有效加强应用系统安全管理，提升应用系统安全编码能力，指导开发团队有效进行应用系统安全编码，特制定本规范。
C/C++编程规范：代码命名与编码标准
这些规范不仅包括了变量、函数、类等编程元素的命名规则，还包括了代码排版、注释、文件组织等其他重要的编程实践。规范的目的是为了帮助开发人员编写出清晰、一致、易于协作和维护的代码。 使用该资源时，用户首先...
让你提前认识软件开发(6)：程序的版式和注释
周兆熊的专栏
03-23 5014
在《高质量程序设计指南(C/C++语言)》中，作者说：可以把程序的版式比喻为“书法”，好的“书法”可以让人对程序一目了然，看得兴致勃勃。确实，我们一打开程序，首先看到的便是程序的排版，我们的第一印象便是程序写得是工整还是凌乱。都说第一印象很重要，为了给大家留下好的第一印象，我们一定要注重程序的版式。         此外，好的注释能够帮助读者更快地理解程序，提高工作的效率。也许是因为工作比较忙的
Python 技巧篇-开头注释怎么写最好，开头注释需要包含什么，开头注释的重要性
小蓝枣的博客
03-17 9871
Python 技巧篇-开头注释怎么写最好，开头注释需要包含什么，开头注释的重要性。 开头注释除了必要的信息外，一些简单的介绍也是尤为重要呢，比如作者、创建日期、更新日期、里面代码大体是实现什么功能的简要介绍。这些介绍不但是规范，更是一种认真工作态度的体现。 #!/user/bin/env python # -*- coding:utf-8 -*-
C++复习笔记--C++常用注释规范
牵一只蜗牛去散步
09-15 2145
⑨ @retval 表示返回值，用于说明返回值的意义（例如可以说明 -1 表示异常）① @brief 表示简介，用于简单介绍函数或类的作用和功能；② @param 表示参数，用于介绍和说明函数或类的参数；③ @return 表示返回类型，用于说明函数的返回类型；⑦ @exception 用于说明可能引起的异常信息；⑧ @property 表示属性，用于说明属性信息；⑥ @version 表示版本，用于介绍版本信息；④ @author 表示作者，用于介绍作者信息；⑤ @data 表示日期，用于介绍日期信息；
opencv注释中的@brief、@code/@endcode、@param、@sa 以及 如何在pycharm中看到opencv函数的完整注释
jiongta9473的博客
12-22 9267
主要是参考opencv官方文档中的解释： OpenCV: Writing documentation for OpenCV 一、说明 opencv在注释里面加入这些标志符号的原因是其使用了Doxygen这个程序，Doxygen这个软件可以通过标志符号将注释里面的内容收集起来组成一个完整的用户手册；简化了用户手册的制作过程。 @brief、@code/@endcode、@param、@sa这些符号都是Doxygen程序的语法需要。 二、符号的详细解释 例子： /** @brief Calcu
VSCode中的注释规范
sandalphon4869的博客
01-04 1万+
文章目录一、OpenCV的官方文档的写法 一、OpenCV的官方文档的写法 用/** */写注释块，不是用行注释//也不是/* */ 在第二行处加个空行。这样之后每行就不是以*开头（不方便复制）。 注释符号： @brief：简要描述 @param：参数描述 @return：用它来制定一个 method 或 function的返回值 @note：注意点 @see：用它来指明其他相关的 meth...
Qt设置通用模板快速注释
风起时~微凉的博客
05-31 756
菜单->工具->选项->文本编辑器->片段； 添加一个片段, 比如名字是custom, 触发种类是这个片段的简单描述； 当我们在代码文件中键入cunstom时, 会自动弹出智能提醒, 选择我们的代码片段回车, 自动填充代码； 按tab可以在变量间切换, 输入完成后回车, 完成编辑； 新建片段代码如下： /** * @brief File Description * @author Admin * @date %{CurrentDate:
@brief、@param 和 @return 是常用的文档注释标记
最新发布
Yy468545的博客
04-15 1555
在 C++ 中，@brief@param和@return是常用的文档注释标记，用于生成代码文档（例如使用 Doxygen 工具）。
看懂源码之注释规范
qq_29012777的博客
10-10 5387
1.前言为了增强源代码的可阅读性、结构性，方便代码阅读者对源代码的阅读和理解，以及方便源代码文档的制作和生成，源代码的注释通常按一定的规范编写。 所以要想更好的读懂源码，就必须对注释规范有一定的了解。2.注释详解2.1 定义注释块/*! * 一个注释块 */ 2.2 文件注释块/*! * @file 文件名 * @brief 文件简要说明 * @author 作者 * @date 时间
备注注释等
C18304057755的博客
12-13 760
是一种注释标签，通常在函数或类的注释中使用，用于提供对其作用的简要描述。是一种注释标签，通常在函数的注释中使用，用于提供对函数参数的描述信息。是一种注释标签，通常在函数的注释中使用，用于提供函数的返回值信息。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值