DotNetNuke 代码文档(卿苏德翻译）

        说明 ：  昨天认识了一位小兄弟，他叫卿苏德 勤学好问 讨人喜欢，今天早上拜托他翻译技术文档，他居然用了两个小时就可以翻译出来，而且效果还不错。放到这里来大家参考，我么还可以共同帮助他完善。

介绍

 
DotNetNuke是 由微软发起的一个开放源代码项目，这个项目一直都排在active projects in the Workspaces directory 的前5位，拥有超过40,000的注册用户，而且以每周约1500的新用户的速度增长。其最初的 codebase 非常接近 IBuySpy 网站 的Version 1 ，随着每个新版本的发布, DotNetNuke引起越来越多的人的关注。  DotNetNuke Version 2 具有重大的意义，因为它标志着DotNetNuke与IBuySpy origins的分离.。
 

背景

 
Visual Studio .Net建议为C# projects采用以XML为基础的注释。 这些注释能被编译器抽取出来为codebase生成文档，这为C#的开发研究提供了巨大的价值。但不幸的是，the VB.Net development team选择不包含这种特性  。因此，一些 third party products（第三方产品）被开发出来用来扩展VB.NET的XML注释。  Microsoft 也决定在Visual Studio.Net的下一个版本里，使VB.NET包含对XML注释的支持。
 

工具

/*http://www.microsoft.com/china/MSDN/library/enterprisedevelopment/softwaredev/TenMHToolEDevShouDN.mspx 参考网址*/
 
DotNetNuke 选择2种工具来创建和编译代码注释
 
VBCommenter 1.1.1 - The VBCommenter 是Visual Studio .NET 2003的一个插件，功能如下:

能够为每个在VB .NET编辑器里的类、方法和属性自动生成文件头和XML注释。

XML 注释文件在你创建程序的时候被同时创建，这可以帮助你为你的类型库创建一个全功能的帮助文件。

VBCommenter是一个开放源代码项目，并且可以从 GotDotNet 免费获得: http://www.gotdotnet.com/Community/Workspaces/Workspace.aspx?id=112b5449-f702-46e2-87fa-86bdf39a17dd

 
NDoc 1.2 – Ndoc用C#编译器（VB.NET的插件）生成的.NET程序集 以及 XML 文档生成类库的文档资料

NDoc 可以把文件以几种不同的格式生成文档资料, 包括 the MSDN-style HTML Help format (.chm), the Visual Studio .NET Help format (HTML Help 2), and MSDN-online style web pages.

The NDoc 的源代码可以免费获得，不过先得获得 Open Source 的许可证.

NDoc的下载地址:    http://ndoc.sourceforge.net/

XML 注释

 
VBCommenter使用为C#定义的标签（Tags）实现XML 注释且将代码中的文档资料注释转化为一个XML文件
标签（Tags） are processed on code constructs such as （类型和类型成员？）types and type members.
以下标签（tags）为用户文档（user documentation）提供了基本的功能:

<c>	<para>	<see>
<code>	<param>	<seealso>
<example>	<paramref>	<summary>
<exception>	<permission>	<value>
<include>	<remarks>
<list>	<returns>

   
你能从Visual Studio documentation. 了解更多的标签（tag）

使用 VBCommenter

 
安装后, VBCommenter 几乎为任何类型 (类, 方法, 枚举,等) 生成 XML注释模板.  创建一个标准的模板，注意每行注释前面必须保证有 ’’’
 
用VBCommenter注释方法  看下面的代码例子:
''' -------------------------------------------------------------------
''' <summary>
'''
''' </summary>
''' <param name="Files"></param>
''' <remarks>
''' </remarks>
''' <history>
'''    [jbrinkman]   2/2/2004   Created
''' </history>
''' -------------------------------------------------------------------
Public Sub ExecuteSql(ByVal Files As ArrayList)
…
    …
    …
End Sub 'ExecuteSql
 
至少, 这个基本模板可以为每个公共或保护的枚举类型、类、属性、方法和域（field）填写.另外,你还可以用上面定义的标签 (tags）来进一步注释代码.
 
文档必须遵从MSDN documentation指定的文档模式.
总结标签Summary tag–解释应该简短且令人愉快。应该给注释对象一个简短的概括性的解释

备注标签Remarks tag–对注释对象的目的和用法进行充分的解释.

备注部分可能包括对对象（object）进行附加说明的标签.

 
当项目编译时, VBCommenter将在build directory里创建一个名称和工程（project）名一样的XML文件.

使用 NDoc

一旦VBCommenter 创建XML文件, NDOC将被用来生成MSDN 类型的帮助文件.  要创建帮助文件: 打开一个新的工程（project），添加工程的动态链接库（dll’s）和相关的XML文件.XML Comment 说明书并不提供文件的命名空间功能.用Use the Namespace Summary 按钮来为工程命名空间添加概要说明.  下面的图片显示了简单的设置. 你能使用工具栏或菜单来生成和预览你的文档.

介绍

 
DotNetNuke是 由微软发起的一个开放源代码项目，这个项目一直都排在active projects in the Workspaces directory 的前5位，拥有超过40,000的注册用户，而且以每周约1500的新用户的速度增长。其最初的 codebase 非常接近 IBuySpy 网站 的Version 1 ，随着每个新版本的发布, DotNetNuke引起越来越多的人的关注。  DotNetNuke Version 2 具有重大的意义，因为它标志着DotNetNuke与IBuySpy origins的分离.。
 

背景

 
Visual Studio .Net建议为C# projects采用以XML为基础的注释。 这些注释能被编译器抽取出来为codebase生成文档，这为C#的开发研究提供了巨大的价值。但不幸的是，the VB.Net development team选择不包含这种特性  。因此，一些 third party products（第三方产品）被开发出来用来扩展VB.NET的XML注释。  Microsoft 也决定在Visual Studio.Net的下一个版本里，使VB.NET包含对XML注释的支持。
 

工具

/*http://www.microsoft.com/china/MSDN/library/enterprisedevelopment/softwaredev/TenMHToolEDevShouDN.mspx 参考网址*/
 
DotNetNuke 选择2种工具来创建和编译代码注释
 
VBCommenter 1.1.1 - The VBCommenter 是Visual Studio .NET 2003的一个插件，功能如下:

能够为每个在VB .NET编辑器里的类、方法和属性自动生成文件头和XML注释。

XML 注释文件在你创建程序的时候被同时创建，这可以帮助你为你的类型库创建一个全功能的帮助文件。

VBCommenter是一个开放源代码项目，并且可以从 GotDotNet 免费获得: http://www.gotdotnet.com/Community/Workspaces/Workspace.aspx?id=112b5449-f702-46e2-87fa-86bdf39a17dd

 
NDoc 1.2 – Ndoc用C#编译器（VB.NET的插件）生成的.NET程序集 以及 XML 文档生成类库的文档资料

NDoc 可以把文件以几种不同的格式生成文档资料, 包括 the MSDN-style HTML Help format (.chm), the Visual Studio .NET Help format (HTML Help 2), and MSDN-online style web pages.

The NDoc 的源代码可以免费获得，不过先得获得 Open Source 的许可证.

NDoc的下载地址:    http://ndoc.sourceforge.net/

XML 注释

 
VBCommenter使用为C#定义的标签（Tags）实现XML 注释且将代码中的文档资料注释转化为一个XML文件
标签（Tags） are processed on code constructs such as （类型和类型成员？）types and type members.
以下标签（tags）为用户文档（user documentation）提供了基本的功能:

<c>	<para>	<see>
<code>	<param>	<seealso>
<example>	<paramref>	<summary>
<exception>	<permission>	<value>
<include>	<remarks>
<list>	<returns>

   
你能从Visual Studio documentation. 了解更多的标签（tag）

使用 VBCommenter

 
安装后, VBCommenter 几乎为任何类型 (类, 方法, 枚举,等) 生成 XML注释模板.  创建一个标准的模板，注意每行注释前面必须保证有 ’’’
 
用VBCommenter注释方法  看下面的代码例子:
''' -------------------------------------------------------------------
''' <summary>
'''
''' </summary>
''' <param name="Files"></param>
''' <remarks>
''' </remarks>
''' <history>
'''    [jbrinkman]   2/2/2004   Created
''' </history>
''' -------------------------------------------------------------------
Public Sub ExecuteSql(ByVal Files As ArrayList)
…
    …
    …
End Sub 'ExecuteSql
 
至少, 这个基本模板可以为每个公共或保护的枚举类型、类、属性、方法和域（field）填写.另外,你还可以用上面定义的标签 (tags）来进一步注释代码.
 
文档必须遵从MSDN documentation指定的文档模式.
总结标签Summary tag–解释应该简短且令人愉快。应该给注释对象一个简短的概括性的解释

备注标签Remarks tag–对注释对象的目的和用法进行充分的解释.

备注部分可能包括对对象（object）进行附加说明的标签.

 
当项目编译时, VBCommenter将在build directory里创建一个名称和工程（project）名一样的XML文件.

使用 NDoc

一旦VBCommenter 创建XML文件, NDOC将被用来生成MSDN 类型的帮助文件.  要创建帮助文件: 打开一个新的工程（project），添加工程的动态链接库（dll’s）和相关的XML文件.XML Comment 说明书并不提供文件的命名空间功能.用Use the Namespace Summary 按钮来为工程命名空间添加概要说明.  下面的图片显示了简单的设置. 你能使用工具栏或菜单来生成和预览你的文档.