By using this site, you agree to our updated Privacy Policy and our Terms of Use. Manage your Cookies Settings.
435,491 Members | 3,273 Online
Bytes IT Community
+ Ask a Question
Need help? Post your question and get tips & solutions from a community of 435,491 IT Pros & Developers. It's quick & easy.

Is there a way to construct a "smart" code snippet?

P: n/a
what i want is a snippet of an XML comment, that when inserted above a
method, will pickup stuff like the return value, etc.

by default, a /// will supply method parameters, but not much else.

thanks...

Nov 16 '06 #1
Share this Question
Share on Google+
6 Replies


P: n/a
/// *does* pickup return value. The only useful thing that I think it
could provide (from source code) is the exception, and possibly
permission (declarative; imperative would be too complex) elements...
perhaps you could log them (and anything else you think it should do)
as a VAE on "connect"?

(http://connect.microsoft.com/VisualStudio/feedback)

Marc

Nov 16 '06 #2

P: n/a
Take a look at this. It also guesses at comment for standard method names.
Very cool for about 60% of comments

http://www.roland-weigelt.de/downloa...stDoc1.9.5.zip

Ciaran O'Donnell

"forest demon" wrote:
what i want is a snippet of an XML comment, that when inserted above a
method, will pickup stuff like the return value, etc.

by default, a /// will supply method parameters, but not much else.

thanks...

Nov 16 '06 #3

P: n/a
I'll second the vote for GhostDoc. I use it, and it's great. No, it
doesn't always work, but it does a pretty good job.

--
Adam Clauss

"Ciaran O''Donnell" <Ci************@discussions.microsoft.comwrote in
message news:4B**********************************@microsof t.com...
Take a look at this. It also guesses at comment for standard method names.
Very cool for about 60% of comments

http://www.roland-weigelt.de/downloa...stDoc1.9.5.zip

Ciaran O'Donnell

"forest demon" wrote:
>what i want is a snippet of an XML comment, that when inserted above a
method, will pickup stuff like the return value, etc.

by default, a /// will supply method parameters, but not much else.

thanks...


Nov 16 '06 #4

P: n/a
"Ciaran O''Donnell" <Ci************@discussions.microsoft.comwrote in
message news:4B**********************************@microsof t.com...
It also guesses at comment for standard method names.
Does it do a better job than humans? What I mean is, if the comment can be
inferred from the method name, what's the point of the comment?

///ark
Nov 16 '06 #5

P: n/a
JR
Soething like:

i++; // Add 1 to i

JR

"Mark Wilden" <mw*****@communitymtm.comwrote in message
news:e$**************@TK2MSFTNGP02.phx.gbl...
"Ciaran O''Donnell" <Ci************@discussions.microsoft.comwrote in
message news:4B**********************************@microsof t.com...
>It also guesses at comment for standard method names.

Does it do a better job than humans? What I mean is, if the comment can be
inferred from the method name, what's the point of the comment?

///ark

Nov 16 '06 #6

P: n/a
hey, thanks everyone...i do appreciate the input!
JR wrote:
Soething like:

i++; // Add 1 to i

JR

"Mark Wilden" <mw*****@communitymtm.comwrote in message
news:e$**************@TK2MSFTNGP02.phx.gbl...
"Ciaran O''Donnell" <Ci************@discussions.microsoft.comwrote in
message news:4B**********************************@microsof t.com...
It also guesses at comment for standard method names.
Does it do a better job than humans? What I mean is, if the comment can be
inferred from the method name, what's the point of the comment?

///ark
Nov 18 '06 #7

This discussion thread is closed

Replies have been disabled for this discussion.