类文件创建时自动带注释
对于vs2013来讲,
步骤:
1.VS2013 中找到(安装盘符以C盘为例)C:ProgramFiles(x86)Microsoft VisualStudio12.0Common7IDEItemTemplatesCacheCSharpCode2052Class
Code文件夹指类代码, 2052文件夹下的每个文件的.cs文件都加也行。。
若路径是:
C:Program Files (x86)Microsoft Visual Studio 12.0Common7IDEItemTemplatesCacheCSharpWindows Forms2052Form
则是添加窗体的时候,自动加注释。
对于vs2008来讲,路径是C:Program Files (x86)Microsoft Visual Studio 9.0Common7IDEItemTemplatesCacheCSharpCode2052Class.zip
2.在Class.cs 文件最上面 添加如下代码。
/*
* ==============================================================================
*
* File name: $safeitemname$
* Description:
*
* Version: 1.0
* Created: $time$
*
* Author: Your name
* Company: Your company name
*
* Compiler: Visual Studio 2013
* Machine name: $machinename$
* CLR Version: $clrversion$
*
* ==============================================================================
*/
或者:
/*************************************************************************************
* CLR版本: $clrversion$
* 类 名 称: $itemname$
* 机器名称: $machinename$
* 命名空间: $rootnamespace$
* 文 件 名: $safeitemname$
* 创建时间: $time$
* 作 者: xxx
* 说 明:
* 修改时间:
* 修 改 人:
*************************************************************************************/
3.这样在新建c#类文件时就会自动添加注释说明信息了。
我采用的是下面这种:
/*
* ==============================================================================
*
* File name: $safeitemname$
* Description:
*
* Version: 1.0
* Created: $time$
*
* Author: Your name
* Company: Your company name
*
* ==============================================================================
*/
$safeitemname$、$rootnamespace$ ??
这些参数都是系统变量,功能类似于Foxmail模版里面的宏。
其他可用的参数有:(需要注意:这些参数区分大小写!)
如何让发布的C#的DLL类库中的方法带有注释说明
一个类库让第三方引用时,默认情况下生成类库时不携带注释,所以别人引用这个类库时就不是很方便理解类方法的作用和每个参数的含义,若是能携带方法的说明注释就好了。
具体设置是 项目---属性-生成,将“XML文档文件”选中即可。
代码规范
DLL将共享出去时 注意代码规范,编译一下dll项目,在底下“错误列表”中就能看出 有些警告和消息。
例如:
属性和方法名 首字母都要大写;
方法的每个参数都要注释;
每个类需要注释;
每个字段属性都注释......