自动生成头注释文件

来源:互联网 发布:python 字符串格式化 编辑:程序博客网 时间:2024/05/16 11:18

楔子

    进行有关程序方面工作的都知道,一段简洁易懂质量高的代码离不开注释的强有力辅助,在团队合作开发中注释更是发挥着举足轻重的作用。但是我们常常对那些重复性的诸如头部注释这样的注释感到疲惫不堪。下面我们就以头部注释为例进行“自动生成重复注释(诸如头部注释)”的方法讲解。

操作

    自动生成头部注释其实挺简单的,主要是对系统引用区进行一些设置即可,下面我们进入正题:

IDE

    Windows10专业版
    VS2013

步骤

1、安装目录中的有效IDE

    找到我们的vs默认安装目录中的IDE。由于大家安装的系统和vs的版本不尽相同, 这里仅以我的笔记本进行参考性建议:

    C:\Program Files (x86)\Microsoft Visual Studio12.0\Common7\IDE


2、遍历显示"Class.cs"

    在有效IDE文件下搜索“Class.cs”

3、添加头部注释

    编辑好自己的头部注释,以记事本方式打开每个搜索结果并进行头部注释的添加

4、效果对比

    修改前


    修改后


注意事项

    1、步骤1中的路径可能会因为大家安装的操作系统和IDE这两者的版本的不同而不同,请注意。

    2、进行步骤3时,对每个搜索结果我们都需要在以记事本方式打开后添加自己写好的头部注释。

交流分享

    有两个小问题没有找到答案,哪位好心人帮忙解答下,不胜感激:
    1、步骤1中路径指向的是VS2013的什么文件夹?
    2、我们添加头部注释的区域是叫"系统引用区"吗?
感谢您的宝贵时间,祝您生活愉快,谢谢~~~~
—joker
0 0
原创粉丝点击