DotNetNuke(DNN)
2024-07-21 02:16:04
供稿:网友
dotnetnuke介绍:
ibuyspy 门户解决方案软件包在 2002 年一月的发布之后, 已经被微软开发社区接受为创建 asp.net 程序重要的参考。 众所周知ibs最初包括了构造数据驱动的企业内网和互联网网站程序的架构。然而,随着时间推移,大家越来越发现它的主要限制在于最初的 codebase 是完全静态。
开源的目的很简单: 当所有的程序员能读程序源代码,能重新构造程序,能为一个软件修正原始码的时候,软件发展速度可想而知,这完全不同于传统的软件开发理念!
dotnetnuke 是 ibuyspy 门户程序的一个加强和改造,她也是开源的。 开发团队对核心程序的增强正在不断的展现! dotnetnuke 提供的是自动化的、 100% 交互的数据驱动的门户内容管理系统。
dotnetnuke资源站点:
http://v2.dnnchina.net/
介绍
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 按钮来为工程命名空间添加概要说明. 下面的图片显示了简单的设置. 你能使用工具栏或菜单来生成和预览你的文档.