Home All Groups Group Topic Archive Search About

XML Comments File Generated

Author
6 Jan 2006 3:16 PM
JimStone
The assembly name for my project is company.dept.project.v1.0.dll

I would expect the xml file to be the same - replacing .dll with .xml  but
it is also dropping the last .0   and creating company.dept.project.v1.xml

I abbreviated the company name to see if it was a total length problem, but
got the same result.

Am I missing something or is this a bug?
--
Jim

Author
9 Jan 2006 8:19 AM
Gary Chang[MSFT]
Hi Jim,

>I would expect the xml file to be the same - replacing .dll with .xml
> but  it is also dropping the last .0 and creating
company.dept.project.v1.xml

Would you please tell me which version of the Visual Studio you concerned?

In VS2005, if you have a company.dept.project.v1.0 class library, then its
corresponding xml documentation file's name would be
company.dept.project.v1._0.xml,  the leading underscore character in front
of the number is by design.


Thanks!

Best regards,

Gary Chang
Microsoft Community Support
--------------------
Get Secure! ¡§C www.microsoft.com/security
Register to Access MSDN Managed Newsgroups!
http://support.microsoft.com/default.aspx?scid=/servicedesks/msdn/nospam.asp
&SD=msdn

This posting is provided "AS IS" with no warranties, and confers no rights.
Author
10 Jan 2006 6:01 PM
JimStone
Gary,

I am using VS 2005 8.0.50727.42

There is no underscore being added.   The .0 is just being dropped.

I worked around it as Jay suggested by directly editing the vbproj file
--
Jim


""Gary Chang[MSFT]"" wrote:

Show quoteHide quote
> Hi Jim,
>
> >I would expect the xml file to be the same - replacing .dll with .xml
> > but  it is also dropping the last .0 and creating
> company.dept.project.v1.xml
>
> Would you please tell me which version of the Visual Studio you concerned?
>
> In VS2005, if you have a company.dept.project.v1.0 class library, then its
> corresponding xml documentation file's name would be
> company.dept.project.v1._0.xml,  the leading underscore character in front
> of the number is by design.
>
>
> Thanks!
>
> Best regards,
>
> Gary Chang
> Microsoft Community Support
> --------------------
> Get Secure! ¡§C www.microsoft.com/security
> Register to Access MSDN Managed Newsgroups!
> http://support.microsoft.com/default.aspx?scid=/servicedesks/msdn/nospam.asp
> &SD=msdn
>
> This posting is provided "AS IS" with no warranties, and confers no rights.
>
>
Author
11 Jan 2006 6:45 AM
Gary Chang[MSFT]
Hi Jim,

I used the same VS2005 as yours, but I cannot repro the problem on my side,
the corresponding <DocumentationFile> line in my vbproj is as the following:

<DocumentationFile> company.dept.project.v1._0.xml</DocumentationFile>


Thanks!

Best regards,

Gary Chang
Microsoft Community Support
--------------------
Get Secure! ¡§C www.microsoft.com/security
Register to Access MSDN Managed Newsgroups!
http://support.microsoft.com/default.aspx?scid=/servicedesks/msdn/nospam.asp
&SD=msdn

This posting is provided "AS IS" with no warranties, and confers no rights.
Author
12 Jan 2006 4:45 AM
Jay B. Harlow [MVP - Outlook]
Gary,
I'm not 100%, I believe where my went awry was on a project where I renamed
the project. It seemed like the doc file kept the original name, while the
assembly gain the new name.

Normally I name my projects with spaces in them, then I change the assembly
name to replace the spaces with periods.

In Jim's case I would name the project "company dept project v1.0", while I
would name the assembly "company.dept.project.v1.0.xxx" Where xxx is either
EXE or DLL.

--
Hope this helps
Jay [MVP - Outlook]
..NET Application Architect, Enthusiast, & Evangelist
T.S. Bradley - http://www.tsbradley.net


""Gary Chang[MSFT]"" <v-gar***@online.microsoft.com> wrote in message
Show quoteHide quote
news:wO0OaqnFGHA.3680@TK2MSFTNGXA02.phx.gbl...
| Hi Jim,
|
| I used the same VS2005 as yours, but I cannot repro the problem on my
side,
| the corresponding <DocumentationFile> line in my vbproj is as the
following:
|
| <DocumentationFile> company.dept.project.v1._0.xml</DocumentationFile>
|
|
| Thanks!
|
| Best regards,
|
| Gary Chang
| Microsoft Community Support
| --------------------
| Get Secure! ¡§C www.microsoft.com/security
| Register to Access MSDN Managed Newsgroups!
|
http://support.microsoft.com/default.aspx?scid=/servicedesks/msdn/nospam.asp
Show quoteHide quote
| &SD=msdn
|
| This posting is provided "AS IS" with no warranties, and confers no
rights.
|
Author
12 Jan 2006 5:16 AM
Gary Chang[MSFT]
Hi,

>I'm not 100%, I believe where my went awry was on a project where
>I renamed the project. It seemed like the doc file kept the original
>name, while the assembly gain the new name.

yes, the XML Comments doc will not use the new assembly automatically, I
think we need change it in the <DocumentationFile> line of the
corresponding project file(.vbproj or .csproj) manually.


Thanks for your understanding!

Best regards,

Gary Chang
Microsoft Community Support
--------------------
Get Secure! ¡§C www.microsoft.com/security
Register to Access MSDN Managed Newsgroups!
http://support.microsoft.com/default.aspx?scid=/servicedesks/msdn/nospam.asp
&SD=msdn

This posting is provided "AS IS" with no warranties, and confers no rights.
Author
10 Jan 2006 5:40 PM
Jay B. Harlow [MVP - Outlook]
Jim,
I've had a project where the files didn't match. I simply opened the project
file itself in notepad & corrected the offending entry.

Open: company.dept.project.v1.0.vbproj

Change the <DocumentationFile> lines.

As Gary suggests, the _0 appears to be required. I suspect because 0 is not
a valid "namespace" identifier or some such...

--
Hope this helps
Jay [MVP - Outlook]
..NET Application Architect, Enthusiast, & Evangelist
T.S. Bradley - http://www.tsbradley.net


Show quoteHide quote
"JimStone" <JimStone@newsgroups.nospam> wrote in message
news:1ADE11A3-CB1A-403C-AAF5-5F279655A3ED@microsoft.com...
| The assembly name for my project is company.dept.project.v1.0.dll
|
| I would expect the xml file to be the same - replacing .dll with .xml  but
| it is also dropping the last .0   and creating company.dept.project.v1.xml
|
| I abbreviated the company name to see if it was a total length problem,
but
| got the same result.
|
| Am I missing something or is this a bug?
| --
| Jim