DotNetNuke Introduction:
After the release of the IBuySpy Portal solution package in January 2002, it has been accepted by the Microsoft Development Community as an important reference for creating the ASP.net program. It is well known that IBS initially consisted of structuring data-driven intranet and Internet Web site programs. However, as time goes on, it is increasingly found that the main limitation is that the initial codebase is completely static.
The purpose of open source is simple: when all programmers can read the source code, can reconstruct the program, for a software to modify the original code, software development speed can be imagined, this is completely different from the traditional concept of software development!
DotNetNuke is an enhancement and transformation of the IBuySpy portal program, and she is also open source. The development team to the core process of the enhancement is constantly showing! DotNetNuke provides an automated, 100% interactive data-driven portal content management system.
DotNetNuke Resource site:
http://v2.dnnchina.net/
Introduced
DotNetNuke is an open source project initiated by Microsoft, which has been ranked in the top 5 of active projects in the Workspaces directory, with more than 40,000 registered users, And it's growing at a rate of about 1500 new users a week. Its initial codebase is very close to the IBuySpy website version 1, with the release of each new version, DotNetNuke has aroused more and more people's attention. DotNetNuke Version 2 is of great significance because it marks the separation of DotNetNuke from IBuySpy origins.
Background
Visual Studio. NET recommends using XML based annotations for C # projects. These annotations can be extracted by the compiler to generate documents for CodeBase, which provides a great value for the development research of C #. Unfortunately, the VB.net development team selection does not include this feature. As a result, some third party product (Third-party products) were developed to extend vb.net XML annotations. Microsoft also decided to include support for XML annotations in the next release of Visual Studio.NET. vb.net.
Tools
/*http://www.microsoft.com/china/msdn/library/enterprisedevelopment/softwaredev/tenmhtooledevshoudn.mspx Reference Website * *
DotNetNuke Select 2 tools to create and compile code comments
Vbcommenter 1.1.1-the Vbcommenter is a plug-in for Visual Studio. NET 2003 with the following features:
Able for each in VB. NET editor to automatically generate file headers and XML annotations for classes, methods, and properties.
XML annotation files are created at the same time as you create them, which can help you create a fully functional Help file for your type library.
Vbcommenter is an open source project and can be obtained free of charge from GotDotNet: http://www.gotdotnet.com/Community/Workspaces/Workspace.aspx?id= 112b5449-f702-46e2-87fa-86bdf39a17dd
NDoc 1.2–ndoc documentation for the. NET assemblies and XML documents generated by the C # compiler (vb.net plug-ins)
NDoc can generate documentation in several different formats, including the Msdn-style HTML Help format (. chm), the Visual Studio. NET helps format (HTML 2), and Msdn-online style Web pages.
The NDoc source code can be obtained free of charge, but first obtain a license to Open source.
NDoc's download Address: http://ndoc.sourceforge.net/
XML annotations
Vbcommenter implements XML annotations using tags defined for C # (tags) and converts documentation comments in code to an XML file
tags (tags) are processed on code constructs such as (type and type members?) ) Types and type members.
The following tags (tags) provide basic functionality for the user's document (users documentation):
<c> <para> <see>
<code> <param> <seealso>
<example> <paramref> <summary>
<exception> <permission> <value>
<include> <remarks>
<list> <returns>
You can documentation from visual Studio. Learn more about tags (tag)
Using Vbcommenter
After installation, Vbcommenter generates an XML annotation template for almost any type (class, method, enumeration, etc.). Create a standard template, note that each line comment must be preceded by a "
Use the Vbcommenter annotation method to look at the following code example:
''' -------------------------------------------------------------------
"' <summary>
'''
"' </summary>
"<param name=" Files "></param>
"' <remarks>
"' </remarks>
"' "[Jbrinkman] 2/2/2004 Created
"' ''' -------------------------------------------------------------------
Public Sub ExecuteSQL (ByVal Files as ArrayList)
...
...
...
End Sub ' ExecuteSQL
At a minimum, this basic template can be filled out for each public or protected enumeration type, class, property, method, and field (field). In addition, you can use the above defined tags (tags) to further annotate the code.
The document must conform to the document mode specified by the MSDN documentation.
Summary Label Summary tag– explanation should be brief and enjoyable. A short, general explanation should be given to the annotation object.
Note Label Remarks tag– explain the purpose and usage of the annotation object adequately.
The Remarks section may include a label that attaches an additional description to the object.
When the project is compiled, Vbcommenter creates an XML file with the same name and project name in build directory.
Using NDoc
Once vbcommenter creates an XML file, NDoc is used to generate the MSDN type of help files. To create a Help file: Open a new Project (project), add the project's dynamic-link library (DLL ' s), and the associated XML file. The XML Comment specification does not provide the namespace functionality of the file. Use the Namespace Summary button to add a summary description of the project namespace. The following picture shows a simple setting. You can use toolbars or menus to generate and preview your documents.
Introduced
DotNetNuke is an open source project initiated by Microsoft, which has been ranked in the top 5 of active projects in the Workspaces directory, with more than 40,000 registered users, And it's growing at a rate of about 1500 new users a week. Its initial codebase is very close to the IBuySpy website version 1, with the release of each new version, DotNetNuke has aroused more and more people's attention. DotNetNuke Version 2 is of great significance because it marks the separation of DotNetNuke from IBuySpy origins.
Background
Visual Studio. NET recommends using XML based annotations for C # projects. These annotations can be extracted by the compiler to generate documents for CodeBase, which provides a great value for the development research of C #. Unfortunately, the VB.net development team selection does not include this feature. As a result, some third party product (Third-party products) were developed to extend vb.net XML annotations. Microsoft also decided to include support for XML annotations in the next release of Visual Studio.NET. vb.net.
Tools
/*http://www.microsoft.com/china/msdn/library/enterprisedevelopment/softwaredev/tenmhtooledevshoudn.mspx Reference Website * *
DotNetNuke Select 2 tools to create and compile code comments
Vbcommenter 1.1.1-the Vbcommenter is a plug-in for Visual Studio. NET 2003 with the following features:
Able for each in VB. NET editor to automatically generate file headers and XML annotations for classes, methods, and properties.
XML annotation files are created at the same time as you create them, which can help you create a fully functional Help file for your type library.
Vbcommenter is an open source project and can be obtained free of charge from GotDotNet: http://www.gotdotnet.com/Community/Workspaces/Workspace.aspx?id= 112b5449-f702-46e2-87fa-86bdf39a17dd
NDoc 1.2–ndoc documentation for the. NET assemblies and XML documents generated by the C # compiler (vb.net plug-ins)
NDoc can generate documentation in several different formats, including the Msdn-style HTML Help format (. chm), the Visual Studio. NET helps format (HTML 2), and Msdn-online style Web pages.
The NDoc source code can be obtained free of charge, but first obtain a license to Open source.
NDoc's download Address: http://ndoc.sourceforge.net/
XML annotations
Vbcommenter implements XML annotations using tags defined for C # (tags) and converts documentation comments in code to an XML file
tags (tags) are processed on code constructs such as (type and type members?) ) Types and type members.
The following tags (tags) provide basic functionality for the user's document (users documentation):
<c> <para> <see>
<code> <param> <seealso>
<example> <paramref> <summary>
<exception> <permission> <value>
<include> <remarks>
<list> <returns>
You can documentation from visual Studio. Learn more about tags (tag)
Using Vbcommenter
After installation, Vbcommenter generates an XML annotation template for almost any type (class, method, enumeration, etc.). Create a standard template, note that each line comment must be preceded by a "
Use the Vbcommenter annotation method to look at the following code example:
''' -------------------------------------------------------------------
"' <summary>
'''
"' </summary>
"<param name=" Files "></param>
"' <remarks>
"' </remarks>
"' "[Jbrinkman] 2/2/2004 Created
"' ''' -------------------------------------------------------------------
Public Sub ExecuteSQL (ByVal Files as ArrayList)
...
...
...
End Sub ' ExecuteSQL
At a minimum, this basic template can be filled out for each public or protected enumeration type, class, property, method, and field (field). In addition, you can use the above defined tags (tags) to further annotate the code.
The document must conform to the document mode specified by the MSDN documentation.
Summary Label Summary tag– explanation should be brief and enjoyable. A short, general explanation should be given to the annotation object.
Note Label Remarks tag– explain the purpose and usage of the annotation object adequately.
The Remarks section may include a label that attaches an additional description to the object.
When the project is compiled, Vbcommenter creates an XML file with the same name and project name in build directory.
Using NDoc
Once vbcommenter creates an XML file, NDoc is used to generate the MSDN type of help files. To create a Help file: Open a new Project (project), add the project's dynamic-link library (DLL ' s), and the associated XML file. The XML Comment specification does not provide the namespace functionality of the file. Use the Namespace Summary button to add a summary description of the project namespace. The following picture shows a simple setting. You can use toolbars or menus to generate and preview your documents.
