首页 > 编程语言 >Doxygen Comment Tags 编程辅助工具注释标记 @brief @param @return

Doxygen Comment Tags 编程辅助工具注释标记 @brief @param @return

时间:2023-05-28 23:46:31浏览次数:35  
标签:Comment Doxygen return Tags 标记 brief 注释

以@brief @param @return 等形式出现的注释标记被称为Doxygen注释标记(Doxygen Comment Tags)或者简称为Doxygen标记。

这玩意常用来作为接口文档说明或者接口源码注释,又比如EmmyLua用这个来作为lua函数的注释以提供智能提示。

常见的doxygen注释标记及其作用:

/**
 * @biref 简介
 * @prarm paramName 函数形参介绍
 * @return returnType 函数返回值类型说明
 * @exception 可能抛出的异常
 * @author 作者
 * @data 时间
 * version 版本
 * property 属性介绍
 */

 

标签:Comment,Doxygen,return,Tags,标记,brief,注释
From: https://www.cnblogs.com/ikun-proto/p/17439163.html

相关文章

  • return
    packagecom.karl2;publicclassreturnDemo{publicstaticvoidmain(String[]args){System.out.println("程序开始");chu(10,5);System.out.println("程序结束");}publicstaticvoidchu(inta,intb){......
  • 第一个react.js程序:create and show comment
    importReact,{Component}from"react";import{render}from"react-dom";importPropTypesfrom"prop-types";constnode=document.getElementById("root");constdata={post:{id:123,content:......
  • webstore报 ESLint: Expected space or tab after '//' in comment.(spaced-comment)
    webstore报:ESLint:Expectedspaceortabafter'//'incomment.(spaced-comment) 解决方法:禁用ESLINT......
  • Named Return Value Optimization (NRVO)
    NamedReturnValueOptimization(NRVO)是一种编译器优化技术,可以避免在函数返回时创建临时对象和调用拷贝构造函数。它的条件是函数返回的对象有一个名字,而且和目标对象的类型相同。例如:classA{public:A();A(constA&);};Af(){Aa;//aisanamedob......
  • C#中的yield return详细解释
    C#中的yieldreturn是一个强大的关键字,它可以帮助我们在不创建临时集合的情况下,实现可枚举的值的生成。yieldreturn可以实现延迟执行(LazyEvaluation),更具可读性和优化内存的使用。yieldreturn的工作原理在C#中,当我们使用yieldreturn时,编译器会为我们生成一个名为......
  • Doxygen风格的常用注释
    最近做小项目用到了Doxygen风格的注释mentor说没必要装Doxygen 下面列一下常用的注释@exception<exception-object>{exceptiondescription}对一个异常对象进行注释。@warning{warningmessage}一些需要注意的事情@todo{thingstobedone}对将要做的事情进行注......
  • C++ return std::move(obj)的效率问题
    在visualstudio2022x32release模式下测得 直接看图即可,可以看出returnstd::move反而会降低性能,而直接返回obj则与直接构造无任何差异。这其实不符合我们对直接返回对象的直觉理解,不过这个和编译器的优化相关,可以详细搜索RVO和NRVO的相关内容。......
  • 第五章学习 循环结构,分支结构,break,continue,return的用法,接收用户数据的fmt.scanl
       packagemainimport"fmt"funcmain(){//实现功能,键盘录入学生age,name,grage,是否为vipvarageintfmt.Println("请录入年龄")//传入age地址的目的:scanln函数中,对地址的值进行改变,实际上是对age值进行改变fmt.Scanln(&age)varname......
  • return View() vs returnPartialView()
    returnView()vsreturnPartialView()InASP.NETMVC,bothreturnView()andreturnPartialView()areusedtoreturnaviewresultfromacontrolleractionmethod.returnView()rendersthefullHTMLlayout,includingthelayoutpage,whilereturnParti......
  • [oeasy]python0048_注释_comment_设置默认编码格式
    注释Comment回忆上次内容使用了版本控制git制作备份进行回滚 尝试了嵌套的控制结构层层控制 不过除非到不得以尽量不要太多层次的嵌套 这样从顶到底含义明确而且还扁平 扁平也能含义明确......