vs中的文档注释类似java中/** */文档注释。能自动的生成帮助文档。
让VS自动生成类的头部注释,只需修改两个文集即可,一下两个路径下个有一个 Class.cs文件
D:\Program Files (x86)\Microsoft Visual Studio 14.0\Common7\IDE\ItemTemplatesCache\CSharp\Code\1033\Class
D:\Program Files (x86)\Microsoft Visual Studio 14.0\Common7\IDE\ItemTemplatesCache\CSharp\Code\2052\Class
用记事本打开=》在头部添加如下代码,OK 新建一个类就自动生成了头部注释。PS:请将安装路径替换为自己VS的安装路径
ItemTemplates与ItemTemplatesCache的区别在于,如果您设置了ItemTemplates下的模板,需要在VS命令行中运行devenv /setup 命令 ,以Itemtemplates模板生成ItemTemplatesCache的模板,也就是说ItemTemplatesCache模板的设置会被原始的Itemtemplates模板还原。所以最好不要轻易改变Itemtemplates模板下的内容(他不能还原)。
/**
* 命名空间: $rootnamespace$
* 类 名: $safeitemrootname$
*
* Ver 负责人 变更内容 变更日期
* ──────────────────────────────────────────────────────────────
* V1.0 shaojinbo 初版 $time$
*
* Copyright (c) 2015 Lir Corporation. All rights reserved.
*┌──────────────────────────────────────────────────────────────┐
*│ 此技术信息为本公司机密信息,未经本公司书面同意禁止向第三方披露. │
*│ 版权所有:********有限公司 │
*└──────────────────────────────────────────────────────────────┘
*/
效果如下:
参数说明 :
官方帮助说明:https://msdn.microsoft.com/zh-cn/library/eehb4faa.aspx
使用方法:$time$ 日期
$year$ 年份
$clrversion$ CLR版本
$GUID$ 用于替换项目文件中的项目 GUID 的 GUID。最多可以指定 10 个唯一的 GUID(例如,guid1))。
$itemname$ 用户在对话框中提供的名称。
$machinename$ 当前的计算机名称(例如,Computer01)。
$projectname$ 用户在对话框中提供的名称。
$registeredorganization$ HKLM\Software\Microsoft\Windows NT\CurrentVersion\RegisteredOrganization 中的注册表项值。
$rootnamespace$ 当前项目的根命名空间。此参数用于替换正向项目中添加的项中的命名空间。
$safeitemname$ 用户在“添加新项”对话框中提供的名称,名称中移除了所有不安全的字符和空格。
$safeprojectname$ 用户在“新建项目”对话框中提供的名称,名称中移除了所有不安全的字符和空格。
$time$ 以 DD/MM/YYYY 00:00:00 格式表示的当前时间。
$userdomain$ 当前的用户域。
$username$ 当前的用户名。