• vs2013下自动注释的运用


    1.首先是VAssistX,可以在VS的工具下,拓展和更新里面找到,然后下载安装即可;

    以下为大家介绍一下怎么添加函数头注释:随便打开一个C++的工程,找到一个方法,右击函数名,然后依次点击“Refacto”–>“Document Method”,这个时候函数头注释是不是已经出来了,很方便吧。但是这个注释格式是默认的,可能不适合你的项目。可以在VAssistX的选项中更改显示样式,在VS2013中点击 “VAssistX”–>”Visual VAssistX Options”然后选择Suggestions,再点击”Edit VA Snippets”,在打开的窗口中选择Refactor Document Method,在这就可以更改你的显示样式了。
    1. //************************************     
    2. // 函数名称: $SymbolName$     
    3. // 函数说明:     
    4. // 作 成 者:Mr.M     
    5. // 作成日期:$DATE$     
    6. // 返 回 值: $SymbolType$     
    7. // 参    数: $MethodArg$     
    8. //************************************  

    这是我设置的,大家赶快试试吧。这个插件会大大的提高你的工作效率。

    VAssistX 函数注释和文件头注释模板

    “VAssistX”–>”Visual VAssistX Options”然后选择Suggestions,再点击”Edit VA Snippets”
    函数模板
    /*************************************************
    // Method: $SymbolName$
    // Description: 
    // Author: K@yee 
    // Date: $DATE$
    // Returns: $SymbolType$
    // Parameter: $MethodArgName$
    // History:
    *************************************************/
     
    头文件注释的时候,在VAssistX->Insert VA Snippet即可,选择header comment;自定义时,在“VAssistX”–>”Visual VAssistX Options”然后选择Suggestions,再点击”Edit VA Snippets”,然后改为With Title Only

    文件头模板
    /*************************************************
    // Copyright (C), 2012-2013, CS&S. Co., Ltd.
    // File name: $FILE_BASE$.$FILE_EXT$
    // Author: K@yee 
    // Version: 1.0 
    // Date: $DATE$
    // Description: 
    // Others:
    // History:
    // <author> K@yee 
    // <time> $DATE$
    // <version> 1.0 
    // <desc> build this moudle 
    *************************************************/
    但是我想新建一个格式,总是有问题,可能是插件的问题,后面又好了,怎么添加的目录呢?直接输入快捷键接好了,添加时间有直接可以选择的,随便自己摸索!!
     
    2.可以自己编辑生成模板,暂时没有实践
     
    3. 在VS环境中集成Doxygen工具 ,利用这个工具自动生成注释文档,将在下一篇总结!
     
  • 相关阅读:
    人人开源框架学习笔记
    Gitea安装笔记
    使用sdk方式获取微信的用户信息
    重写java类的equals()和hashCode方法
    Mysql 实现分页功能
    位运算应用和解析
    java代码POST方式请求SOAP
    java实现文件拷贝
    动态创建线程(多线程)处理大量数据
    ActiveMQ监听者接收信息
  • 原文地址:https://www.cnblogs.com/ranjiewen/p/5360221.html
Copyright © 2020-2023  润新知