Sparx Systems Forum

Enterprise Architect => General Board => Topic started by: Paolo F Cantoni on December 31, 2006, 03:58:59 pm

Title: How to document Namespaces via VSI
Post by: Paolo F Cantoni on December 31, 2006, 03:58:59 pm

I've got Visual Studio 2005 Integration (VSI) going (after a fashion).  I can move comments regarding Classes and features - to and from EA and Visual Studio.

However, I'm also interested in comments associated with Namespaces.  I can't seem to get these to move in either direction...

Does anyone know how?

TIA,
Paolo

Title: Re: How to document Namespaces via VSI
Post by: Eve on January 01, 2007, 01:20:48 pm

I know that EA doesn't do it.

Title: Re: How to document Namespaces via VSI
Post by: Paolo F Cantoni on January 01, 2007, 05:31:36 pm

Feature request submitted...

Thoughts?  Votes?
Paolo

Title: Re: How to document Namespaces via VSI
Post by: «Midnight» on January 03, 2007, 06:20:11 am

Worth doing, but be cautious here.

VS does not take kindly to XML-style comments preceding a Namespace directive. The comment block must be inside the Namespace. This style runs contrary to that commonly used for documenting functions or other blocks of code. EA might have to catch this somehow.

Title: Re: How to document Namespaces via VSI
Post by: Paolo F Cantoni on January 03, 2007, 07:43:27 am

Quote

Worth doing, but be cautious here.

VS does not take kindly to comments preceding a Namespace directive. The comment block must be inside the Namespace. This style runs contrary to that commonly used for documenting functions or other blocks of code. EA might have to catch this somehow.

David,

Can you be more explicit about how VS is unhappy about comments preceding?  Also is this VS2005 or earlier?

TIA,
Paolo

Title: Re: How to document Namespaces via VSI
Post by: «Midnight» on January 03, 2007, 08:58:20 am

My bad, Paolo. I wrote without thinking (I've been programming again as you can see).

This applies to XML-style comments (preceded by ''' in VB or /// in C#).

I have only observed this in VS 2005. It might have been true in earlier versions, but only for C#, and I did not use XML comments at that time. There was a nifty add-in for VB that processed these comments in earlier versions, but VS itself was not (at that time) looking at the comment syntax with XML in mind. It does so in VS 2005.

David