473,416 Members | 1,726 Online
Bytes | Software Development & Data Engineering Community
Post Job

Home Posts Topics Members FAQ

Join Bytes to post your question to a community of 473,416 software developers and data experts.

VS.NET 2005 and VB.NET xml comments.

Has anyone played around with them on VB in the new version yet?

I am interested to get some feedback form people that have used this new
feature before I install next week.

I am using VBXC now to create the xml file and then using Ndoc to create the
help file, but VBCX has a bug in it where it will not create comments unique
comments for each member in an enum. Also, just looking to streamline my
tools a bit. VBXC has been good for me so far but this enum thing has me
thinking about a tool change (nothing negative towards the tool author at
all intended here).

Any comments
--
Raymond R Cassick
CEO / CSA
Enterprocity Inc.
www.enterprocity.com
3380 Sheridan Drive, #143
Amherst, NY 14227
V: 716-316-5973
Blog: http://spaces.msn.com/members/rcassick/
Nov 23 '05 #1
3 3941
"Ray Cassick (Home)" <rc************@enterprocity.com> schrieb:
Has anyone played around with them on VB in the new version yet?

I am interested to get some feedback form people that have used this new
feature before I install next week.


I have only used it in the preview versions but XML comments worked pretty
well.

--
M S Herfried K. Wagner
M V P <URL:http://dotnet.mvps.org/>
V B <URL:http://classicvb.org/petition/>

Nov 23 '05 #2
Ray,
From what I have used the XML comments in VB 2005 they seem to be extremely
well integrated.

I like the fact that they show up in the Object Browser & Intellisense while
you are working on the project, you don't need to wait for an explicit build
of your project to see them.

I added xml comments to an enum, both summary & remarks work for both the
enum itself & for the enum values themselves.

Intellisense shows the summary, while the object browser shows the Summary,
Parameters, Return Values, Exceptions and Remarks...

When you use the XML comments in VB 2005 & use "Edit - Outlining - Collapse
to definitions" you see the summary of the XML comment, which I rather like!

I understand that you will still need to use ndoc to create your final
documentation.

--
Hope this helps
Jay [MVP - Outlook]
..NET Application Architect, Enthusiast, & Evangelist
T.S. Bradley - http://www.tsbradley.net
"Ray Cassick (Home)" <rc************@enterprocity.com> wrote in message
news:eW**************@TK2MSFTNGP10.phx.gbl...
| Has anyone played around with them on VB in the new version yet?
|
| I am interested to get some feedback form people that have used this new
| feature before I install next week.
|
| I am using VBXC now to create the xml file and then using Ndoc to create
the
| help file, but VBCX has a bug in it where it will not create comments
unique
| comments for each member in an enum. Also, just looking to streamline my
| tools a bit. VBXC has been good for me so far but this enum thing has me
| thinking about a tool change (nothing negative towards the tool author at
| all intended here).
|
| Any comments
|
|
| --
| Raymond R Cassick
| CEO / CSA
| Enterprocity Inc.
| www.enterprocity.com
| 3380 Sheridan Drive, #143
| Amherst, NY 14227
| V: 716-316-5973
| Blog: http://spaces.msn.com/members/rcassick/
|
|
Nov 23 '05 #3
Thanks.

Yeah, I figured I would still need to use NDoc (when it officially supports
2005 anyway).

"Jay B. Harlow [MVP - Outlook]" <Ja************@tsbradley.net> wrote in
message news:uv**************@TK2MSFTNGP12.phx.gbl...
Ray,
From what I have used the XML comments in VB 2005 they seem to be
extremely
well integrated.

I like the fact that they show up in the Object Browser & Intellisense
while
you are working on the project, you don't need to wait for an explicit
build
of your project to see them.

I added xml comments to an enum, both summary & remarks work for both the
enum itself & for the enum values themselves.

Intellisense shows the summary, while the object browser shows the
Summary,
Parameters, Return Values, Exceptions and Remarks...

When you use the XML comments in VB 2005 & use "Edit - Outlining -
Collapse
to definitions" you see the summary of the XML comment, which I rather
like!

I understand that you will still need to use ndoc to create your final
documentation.

--
Hope this helps
Jay [MVP - Outlook]
.NET Application Architect, Enthusiast, & Evangelist
T.S. Bradley - http://www.tsbradley.net
"Ray Cassick (Home)" <rc************@enterprocity.com> wrote in message
news:eW**************@TK2MSFTNGP10.phx.gbl...
| Has anyone played around with them on VB in the new version yet?
|
| I am interested to get some feedback form people that have used this new
| feature before I install next week.
|
| I am using VBXC now to create the xml file and then using Ndoc to create
the
| help file, but VBCX has a bug in it where it will not create comments
unique
| comments for each member in an enum. Also, just looking to streamline my
| tools a bit. VBXC has been good for me so far but this enum thing has me
| thinking about a tool change (nothing negative towards the tool author
at
| all intended here).
|
| Any comments
|
|
| --
| Raymond R Cassick
| CEO / CSA
| Enterprocity Inc.
| www.enterprocity.com
| 3380 Sheridan Drive, #143
| Amherst, NY 14227
| V: 716-316-5973
| Blog: http://spaces.msn.com/members/rcassick/
|
|

Nov 23 '05 #4

This thread has been closed and replies have been disabled. Please start a new discussion.

Similar topics

6
by: sathyashrayan | last post by:
Following are the selected thread from the date:30-jan-2005 to 31-jan-2005. I did not use any name because of the subject is important. You can get the original thread by typing the subject...
2
by: Ben Enfield | last post by:
If a variable name is changed and then the intellisense tool tip from "Options to update references to the renamed object" -> "Rename "x" to "y" any XML based comments made for the variable will...
13
by: Andy | last post by:
Hi As I try to learn VB programing I've been playing around with sourcecode from projects hosted on sourceforge. If I open this code in VB 2005 (it is originally developed in VB 2003), it will...
0
by: fiona | last post by:
Innovasys Ltd., a leader in help authoring and documentation tools, today announced the inclusion of a tailored version of the Innovasys HelpStudio help authoring product, HelpStudio Lite, in the...
23
by: deathtospam | last post by:
A day or two ago, I wrote a quick ASPX page with a CS codebehind using Visual Studio .NET 2005 -- it worked, I saved it and closed the project. Today, I came back to the project, reopened the...
0
by: samcar | last post by:
In Visual Studio 2005, there's a feature to create xml documents from comments which later can be turned into microsoft help documents which is the equivalent to javadocs. This feature to create xml...
0
by: emmanuelkatto | last post by:
Hi All, I am Emmanuel katto from Uganda. I want to ask what challenges you've faced while migrating a website to cloud. Please let me know. Thanks! Emmanuel
0
BarryA
by: BarryA | last post by:
What are the essential steps and strategies outlined in the Data Structures and Algorithms (DSA) roadmap for aspiring data scientists? How can individuals effectively utilize this roadmap to progress...
0
marktang
by: marktang | last post by:
ONU (Optical Network Unit) is one of the key components for providing high-speed Internet services. Its primary function is to act as an endpoint device located at the user's premises. However,...
0
by: Hystou | last post by:
Most computers default to English, but sometimes we require a different language, especially when relocating. Forgot to request a specific language before your computer shipped? No problem! You can...
0
Oralloy
by: Oralloy | last post by:
Hello folks, I am unable to find appropriate documentation on the type promotion of bit-fields when using the generalised comparison operator "<=>". The problem is that using the GNU compilers,...
0
jinu1996
by: jinu1996 | last post by:
In today's digital age, having a compelling online presence is paramount for businesses aiming to thrive in a competitive landscape. At the heart of this digital strategy lies an intricately woven...
0
by: Hystou | last post by:
Overview: Windows 11 and 10 have less user interface control over operating system update behaviour than previous versions of Windows. In Windows 11 and 10, there is no way to turn off the Windows...
0
tracyyun
by: tracyyun | last post by:
Dear forum friends, With the development of smart home technology, a variety of wireless communication protocols have appeared on the market, such as Zigbee, Z-Wave, Wi-Fi, Bluetooth, etc. Each...
0
agi2029
by: agi2029 | last post by:
Let's talk about the concept of autonomous AI software engineers and no-code agents. These AIs are designed to manage the entire lifecycle of a software development project—planning, coding, testing,...

By using Bytes.com and it's services, you agree to our Privacy Policy and Terms of Use.

To disable or enable advertisements and analytics tracking please visit the manage ads & tracking page.