CLion文件注释和快捷函数注释
说明
自动文件注释
功能路径
设置➡️编辑器➡️文件和代码模板➡️Include
setting➡️Editor➡️File and Code Templates➡️Includes
这是CLion提供的原模板:
#if ($HEADER_COMMENTS)
//
// Created by $USER_NAME on ${DATE}.
#if ($ORGANIZATION_NAME && $ORGANIZATION_NAME != "")
// Copyright (c) $YEAR ${ORGANIZATION_NAME}#if (!$ORGANIZATION_NAME.endsWith(".")).#end All rights reserved.
#end
//
#end
这是我的模板
#if ($HEADER_COMMENTS)
/**
******************************************************************************
* @file : ${FILE_NAME}
* @author : ${USER}
* @brief : None
* @attention : None
* @date : ${DATE}
******************************************************************************
*/
#if ($ORGANIZATION_NAME && $ORGANIZATION_NAME != "")
// Copyright (c) $YEAR ${ORGANIZATION_NAME}#if (!$ORGANIZATION_NAME.endsWith(".")).#end All rights reserved.
#end
#end
编写位置:
效果如图:
在下图中,可以再次修改生成的文件注释:
这张图片的意思是可以在图片中的位置单独修改头文件的注释。
我的理解是:上面的图片中的设置对头文件和源文件都有效,但是头文件还可以单独再加点东西。要单独设置一些东西可以通过下图设置。
自动生成函数注释
注意: 没有办法识别函数中参数和个数,如需要识别,请浏览下一节注释自动添加参数名。
第六步的内容$ENDS$
会让你的光标停在那里。
第七步的更改中,会出现第二张图的弹窗,只需要勾选C语言和C 的即可。
最后要点应用,然后退出。
触发方式就是在文件任意空白处,写下如下字符:$comments$
【会有自动提示】
如下图所示
最后效果如下图所示:
注释自动添加参数名
在实时模板中没有找到可以识别函数中参数并自动生成注释的方法,下面是另外一种解决办法。
这里是官网的功能介绍:
Doxygen和代码文档-功能
这里是官网的功能帮助:
Doxygen documentation
具体使用
当你输入///
后键入回车,即可得到如下注释:
输入//!
后键入回车,即可得到如下注释:
输入/**
后键入回车,即可得到如下注释:
输入/*!
后键入回车,即可得到如下注释:
输入/*
后回车,得到普通多行注释。
即使函数拥有多个函数,也可以生成。如果参数拥有返回值,则会生成类似于如下注释:
个性化
但是一开始注释中是默认没有@brief
这个选项的,需要自己勾选打开,选项位置如下:
这样,生成的注释中会存在@brief
这一项。
并且考虑到你有更改参数名的可能,这样你不仅需要修改函数中的参数,并且还需要修改注释中的参数名,所以可以将光标移至当前函数行中的任意位置,按下Ctrl F6
即可进行命名重构。
你还可以修改该类注释【Doxygen】,可以在如下位置进行修改:
这篇好文章是转载于:学新通技术网
- 版权申明: 本站部分内容来自互联网,仅供学习及演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系,请提供相关证据及您的身份证明,我们将在收到邮件后48小时内删除。
- 本站站名: 学新通技术网
- 本文地址: /boutique/detail/tanhggghgb
-
photoshop保存的图片太大微信发不了怎么办
PHP中文网 06-15 -
《学习通》视频自动暂停处理方法
HelloWorld317 07-05 -
word里面弄一个表格后上面的标题会跑到下面怎么办
PHP中文网 06-20 -
Android 11 保存文件到外部存储,并分享文件
Luke 10-12 -
photoshop扩展功能面板显示灰色怎么办
PHP中文网 06-14 -
微信公众号没有声音提示怎么办
PHP中文网 03-31 -
excel下划线不显示怎么办
PHP中文网 06-23 -
excel打印预览压线压字怎么办
PHP中文网 06-22 -
TikTok加速器哪个好免费的TK加速器推荐
TK小达人 10-01 -
怎样阻止微信小程序自动打开
PHP中文网 06-13