clion给函数添加注释(可用于生成doxygen文档)

生成符合Doxygen规则的文档注释

用clion编写c/c++代码十分的方便,有很多的快捷键可以使用。假如我们编写代码,给代码添加符合规范的注释,那么可以用Doxygen生成文档(跟opencv官方文档类似的那种)
例如,我们给一个函数添加注释,那么可以这样操作:

/*!
 *
 * @param a : 被除数
 * @param b : 除数
 * @return : 两数相除的结果
 */
double division(double a, double b) {
    if (b) return a / b;
    else return 0;
}

函数的注释是怎么自动生成的呢,我们可以在函数名称上面一行输入/*!(或者///) 然后回车,即可自动生成注释。
详细的说明见官方文档:
https://blog.jetbrains.com/clion/2016/05/keep-your-code-documented/

添加自定义的模板,并且定位光标位置

File—> Settings---->Live Templates------> 添加模板
具体操作见下图:

clion给函数添加注释(可用于生成doxygen文档)_第1张图片
需要注意的是,如果要定位光标的位置,则需要在光标位置写上$END$,例如下面的例子:

int main(int argc, char **argv) {
    $END$    

    return 0;
}

参考:https://www.jetbrains.com/help/clion/template-variables.html#pdtv

你可能感兴趣的:(编程技巧,好用的软件)