C++ 以及keil qt等常见软件注释 @brief @param @return

brief 英[briːf] 美[briːf]
adj. 短时间的; 短暂的; 简洁的; 简单的; 过短的; 暴露身体的;
n. 任务简介; 指示; (向辩护律师提供的) 案情摘要; 委托辩护; 辩护状;
@brief @param @return @author @date @version是代码书写的一种规范
@brief ：简介，简单介绍函数作用
@param ：介绍函数参数
@return：函数返回类型说明
@exception NSException 可能抛出的异常.
@author zhangsan： 作者
@date 2011-07-27 22:30:00 ：时间
@version 1.0 ：版本
@property ：属性介绍

在qt中有自带的会弹出注释，在输入@后这样你就可以选择了,有个小技巧，就是第二行开头输入一个星号*，回车后的其他行的星号* Qt是会自动补充的。

qt中有自带注释根据实测需注意一些几点，不同版本不同系统可能会有不同，欢迎留言补充：

（1）开头是/** 有两个星号不然无法自动弹出注释

（2）@和星号(*)之间需要一个空格不然无法自动弹出注释，

（3）@和星号*不能用中文输入法不然也无法自动弹出注释。

 

 

 

还可添加自己的注释字段

例如：

 

/**
* @brief Create new QToolButton
*
* @param name Name of button
* @param iconPath Path to button icon.
* @return QToolButton Created QToolButton.
*/
QToolButton* createToolButton(QAction *action);

更多代码注释规范可以参考其他人的博客：
https://blog.csdn.net/donhao/article/details/6640096
https://www.cnblogs.com/lyggqm/p/4629711.html

————————————————
原文链接：https://blog.csdn.net/lxj362343/article/details/105711524