MBR IT/.NET 247 : Automatically Adding Default XML Comments on ASPFriends.com 'aspngvs' list

Automatically Adding Default XML Comments

Messages

Related Types

This message was discovered on ASPFriends.com 'aspngvs' list.
Responses highlighted in red are from those people who are likely to be able to contribute good, authoratitive information to this discussion. They include Microsoft employees, MVP's and others who IMHO contribute well to these kinds of discussions.

Little, Ambrose

I don't know how many of you are using XML comments, but we are and they're
great. We do have a complaint, though, and that is that the compiler
generates warnings about all non-private type members that do not have XML
comments. This is good for class libraries but annoying for web forms
because page controls are generally protected and are not consumed by
anything but the deriving ASPX, so it's kind of unnecessary to have XML
comments for them.

What I'm suggesting is that VS.NET automatically add a default <summary />
XML comment to any control declarations it adds to the code behind (i.e.,
when it adds them while you modify the page in Design view). If this or
similar functionality is available now, I'd appreciate knowing about it.

Thanks.

--Ambrose

******************************************************************************
The Company reserves the right to amend statements
made herein in the event of a mistake. Unless expressly
stated herein to the contrary, only agreements in writing signed
by an authorized officer of the Company may be enforced against it.
*******************************************************************************

Reply to this message...

Omar Khan

This is a multi-part message in MIME format.

--------------InterScan_NT_MIME_Boundary
Content-Type: multipart/alternative;
 boundary="----_=_NextPart_001_01C22E7D.67A88CE2"

------_=_NextPart_001_01C22E7D.67A88CE2
Content-Type: text/plain;
 charset="us-ascii"
Content-Transfer-Encoding: quoted-printable

Thank you for the feedback Ambrose. I don't think there is a way to
workaround this behavior in the current product. However, we'll take a
look at fixing it in future versions.

=20

Omar Khan

Visual Studio .NET

=20

=20

-----Original Message-----
From: Little, Ambrose [mailto:Click here to reveal e-mail address]=20
Sent: Thursday, July 18, 2002 9:25 AM
To: aspngvs
Subject: [aspngvs] Automatically Adding Default XML Comments

=20

I don't know how many of you are using XML comments, but we are and
they're great. We do have a complaint, though, and that is that the
compiler generates warnings about all non-private type members that do
not have XML comments. This is good for class libraries but annoying
for web forms because page controls are generally protected and are not
consumed by anything but the deriving ASPX, so it's kind of unnecessary
to have XML comments for them.

=20

What I'm suggesting is that VS.NET automatically add a default <summary
/> XML comment to any control declarations it adds to the code behind
(i.e., when it adds them while you modify the page in Design view). If
this or similar functionality is available now, I'd appreciate knowing
about it.

=20

Thanks.

=20

--Ambrose

************************************************************************
******
The Company reserves the right to amend statements
made herein in the event of a mistake. Unless expressly
stated herein to the contrary, only agreements in writing signed
by an authorized officer of the Company may be enforced against it.
************************************************************************
*******
| [aspngvs] member Click here to reveal e-mail address =3D YOUR ID
| http://www.asplists.com/asplists/aspngvs.asp =3D JOIN/QUIT
| http://www.asplists.com/search =3D SEARCH Archives

------_=_NextPart_001_01C22E7D.67A88CE2
Content-Type: text/html;
 charset="us-ascii"
Content-Transfer-Encoding: quoted-printable

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>

<head>
<META HTTP-EQUIV=3D"Content-Type" CONTENT=3D"text/html; =
charset=3Dus-ascii">

<meta name=3DGenerator content=3D"Microsoft Word 10 (filtered)">
<title>Message</title>

<style>

</style>

</head>

<body lang=3DEN-US link=3Dblue vlink=3Dpurple>

<div class=3DSection1>

Thank you for the feedback =
Ambrose. I don’t
think there is a way to workaround this behavior in the current =
product.
However, we’ll take a look at fixing it in future =
versions.

 

Omar Khan

Visual Studio =
.NET

 

 

-----Original =
Message----- 
From: Little, Ambrose
[mailto:Click here to reveal e-mail address] 
Sent: Thursday, July 18, =
2002 9:25
AM 
To: aspngvs 
Subject: [aspngvs] =
Automatically Adding
Default XML Comments

 

<div>

I don't know how many of =
you are
using XML comments, but we are and they're great. We do have a =
complaint,
though, and that is that the compiler generates warnings about
all non-private type members that do not have XML comments. =
This is
good for class libraries but annoying for web forms because page =
controls are
generally protected and are not consumed by anything but the =
deriving
ASPX, so it's kind of unnecessary to have XML comments for =
them.

</div>

<div>

 

</div>

<div>

What I'm suggesting is =
that VS.NET
automatically add a default <summary /> XML comment to any control
declarations it adds to the code behind (i.e., when it adds them while =
you
modify the page in Design view). If this or similar functionality =
is
available now, I'd appreciate knowing about it.

</div>

<div>

 

</div>

<div>

Thanks.

</div>

<div>

 

</div>

<div>

--Ambrose=

</div>

 
 
<code>********************************************************************=
**********</code> 
<code>The Company reserves the right to amend
statements</code> 
<code>made herein in the event of a mistake. =
Unless
expressly</code> 
<code>stated herein to the contrary, only =
agreements
in writing signed</code> 
<code>by an authorized officer of the Company =
may be
enforced against it.</code> 
<code>********************************************************************=
***********</code> 
| [aspngvs] member Click here to reveal e-mail address =3D YOUR ID 
| http://www.asplists.com/asplists/aspngvs.asp =3D JOIN/QUIT 
| http://www.asplists.com/search =3D SEARCH Archives

</div>

</body>

</html>
=00
------_=_NextPart_001_01C22E7D.67A88CE2--

--------------InterScan_NT_MIME_Boundary--

Reply to this message...

Andy Smith

is there any way to tell vstudio to ignore warnings by number?

__
Andy Smith
Keyboard Jockey #3a7-2.78.1

-----Original Message-----
From: Omar Khan [mailto:Click here to reveal e-mail address]
Sent: Thursday, July 18, 2002 11:06 AM
To: aspngvs
Subject: [aspngvs] RE: Automatically Adding Default XML Comments

Thank you for the feedback Ambrose. I don't think there is a way to workaround this behavior in the current product. However, we'll take a look at fixing it in future versions.

Omar Khan

Visual Studio .NET

-----Original Message-----
From: Little, Ambrose [mailto:Click here to reveal e-mail address]
Sent: Thursday, July 18, 2002 9:25 AM
To: aspngvs
Subject: [aspngvs] Automatically Adding Default XML Comments

I don't know how many of you are using XML comments, but we are and they're great. We do have a complaint, though, and that is that the compiler generates warnings about all non-private type members that do not have XML comments. This is good for class libraries but annoying for web forms because page controls are generally protected and are not consumed by anything but the deriving ASPX, so it's kind of unnecessary to have XML comments for them.

What I'm suggesting is that VS.NET automatically add a default <summary /> XML comment to any control declarations it adds to the code behind (i.e., when it adds them while you modify the page in Design view). If this or similar functionality is available now, I'd appreciate knowing about it.

Thanks.

--Ambrose

******************************************************************************
The Company reserves the right to amend statements
made herein in the event of a mistake. Unless expressly
stated herein to the contrary, only agreements in writing signed
by an authorized officer of the Company may be enforced against it.
*******************************************************************************
| [aspngvs] member Click here to reveal e-mail address = YOUR ID
| http://www.asplists.com/asplists/aspngvs.asp = JOIN/QUIT
| http://www.asplists.com/search = SEARCH Archives

Reply to this message...

Eric Landes (VIP)

Omar,
Are there plans for VB.Net to take advantage of these comments in a future
version? Thanks.
=20
Eric

-----Original Message-----
From: Omar Khan [mailto:Click here to reveal e-mail address]
Sent: Thursday, July 18, 2002 12:06 PM
To: aspngvs
Subject: [aspngvs] RE: Automatically Adding Default XML Comments

Thank you for the feedback Ambrose. I don't think there is a way to
workaround this behavior in the current product. However, we'll take a look
at fixing it in future versions.

=20

Omar Khan

Visual Studio .NET

=20

=20

-----Original Message-----
From: Little, Ambrose [mailto:Click here to reveal e-mail address]=20
Sent: Thursday, July 18, 2002 9:25 AM
To: aspngvs
Subject: [aspngvs] Automatically Adding Default XML Comments

=20

I don't know how many of you are using XML comments, but we are and they're
great. We do have a complaint, though, and that is that the compiler
generates warnings about all non-private type members that do not have XML
comments. This is good for class libraries but annoying for web forms
because page controls are generally protected and are not consumed by
anything but the deriving ASPX, so it's kind of unnecessary to have XML
comments for them.

=20

What I'm suggesting is that VS.NET automatically add a default <summary />
XML comment to any control declarations it adds to the code behind (i.e.,
when it adds them while you modify the page in Design view). If this or
similar functionality is available now, I'd appreciate knowing about it.

=20

Thanks.

=20

--Ambrose

****************************************************************************
**
The Company reserves the right to amend statements
made herein in the event of a mistake. Unless expressly
stated herein to the contrary, only agreements in writing signed
by an authorized officer of the Company may be enforced against it.
****************************************************************************
***
| [aspngvs] member Click here to reveal e-mail address =3D YOUR ID
| http://www.asplists.com/asplists/aspngvs.asp =3D JOIN/QUIT
| http://www.asplists.com/search =3D SEARCH Archives

Confidentiality Notice: This e-mail message, including any
attachments, is for the sole use of the intended recipient(s) and may
contain confidential and privileged information. Any unauthorized
review, use, disclosure or distribution is prohibited. If you are not
the intended recipient, please contact the sender by reply e-mail and
destroy all copies of the original message.

PARTNERS Health Plan Phone: 574-233-4899
100 E. Wayne St., Suite 502 Fax: 574-234-7484
South Bend, IN 46601 www.partnersindiana.com

------_=_NextPart_001_01C231C8.49E108A0

Reply to this message...

MBR BootFX
Best-of-breed application framework for .NET projects, developed by Matthew Baxter-Reynolds and MBR IT

	Copyright © Matthew Baxter-Reynolds 2001-2008. '.NET 247 Software Development Services' is a trading style of MBR IT Solutions Ltd.
	Contact Us - Terms of Use - Privacy Policy - www.dotnet247.com