473,549 Members | 2,784 Online
Bytes | Software Development & Data Engineering Community
+ Post

Home Posts Topics Members FAQ

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

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
6 1472
/// *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
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
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.mi crosoft.comwrot e in
message news:4B******** *************** ***********@mic rosoft.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
"Ciaran O''Donnell" <Ci************ @discussions.mi crosoft.comwrot e in
message news:4B******** *************** ***********@mic rosoft.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
JR
Soething like:

i++; // Add 1 to i

JR

"Mark Wilden" <mw*****@commun itymtm.comwrote in message
news:e$******** ******@TK2MSFTN GP02.phx.gbl...
"Ciaran O''Donnell" <Ci************ @discussions.mi crosoft.comwrot e in
message news:4B******** *************** ***********@mic rosoft.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
hey, thanks everyone...i do appreciate the input!
JR wrote:
Soething like:

i++; // Add 1 to i

JR

"Mark Wilden" <mw*****@commun itymtm.comwrote in message
news:e$******** ******@TK2MSFTN GP02.phx.gbl...
"Ciaran O''Donnell" <Ci************ @discussions.mi crosoft.comwrot e in
message news:4B******** *************** ***********@mic rosoft.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 thread has been closed and replies have been disabled. Please start a new discussion.

Similar topics

9
12244
by: Martin Goldman | last post by:
Hello all, I've been struggling for a few days with the question of how to convert "smart" (curly) quotes into straight quotes. I tried playing with the htmlentities() function, but all that is doing is changing the smart quotes into nonsense characters. I also searched the web for quite a while and was unsuccessful in finding a solution. ...
2
4262
by: Tim Hochberg | last post by:
During the recent, massive, painful Lisp-Python crossposting thread the evils of Python's whitespace based indentation were once again brought to light. Since Python' syntax is so incredibly brittle, and failure prone, it's amazing that we don't have more editor support for our feeble minds. To help reduce the severity of this crisis, I...
14
2656
by: David B. Held | last post by:
I wanted to post this proposal on c.l.c++.m, but my news server apparently does not support that group any more. I propose a new class of exception safety known as the "smart guarantee". Essentially, the smart guarantee promises to clean up resources whose ownership is passed into the function, for whatever defintion of "clean up" is most...
11
7005
by: Ron | last post by:
Hello, I'm having an aggravating time getting the "html" spewed by Word 2003 to display correctly in a webpage. The situation here is that the people creating the documents only know Word, and aren't very computer savvy. I created a system where they can save their Word documents as "html" and upload them to a certain directory, and the...
14
1812
by: Capstar | last post by:
Hi NG, I am developing a piece of software, which contains basicly one loop, which consinsts of 2 parts. Thos two parts are again basicly the same, but they deiffer in some variables. So I changed the variables from foo0 and foo1 to foo, so I can index them. This way I can run through the loop two times more, but switch the index between 0...
2
2367
by: BobAchgill | last post by:
Is there a way to let the User click on a button on a web site and have that download and install my prepackaged compressed data directory and place it nicely under my existing VB .Net Form application on the User's computer? Maybe another way of asking the question is. Can I build a smart .msi "data" installer that will when clicked on as...
3
3208
by: red floyd | last post by:
I've got some code where somebody cut&pasted some comments from MS Word, and so these comments have "smart quotes" (in particular apostrophes) embedded. The apostrophe is character hex 0x92. 2.1 indicates that characters not in the source character set are converted to the universal character name that designates the character. So far,...
5
2882
by: Noozer | last post by:
I'm looking for a "smart folder" program to run on my Windows XP machine. I'm not having any luck finding it and think the logic behind the program is pretty simple, but I'm not sure how I'd implement this. I've done some VB6 programming and dabbled in VS.Net. Can someone share some pointers in how I could implement the following? ...
0
7518
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, people are often confused as to whether an ONU can Work As a Router. In this blog post, we’ll explore What is ONU, What Is Router, ONU & Router’s main...
0
7446
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 effortlessly switch the default language on Windows 10 without reinstalling. I'll walk you through it. First, let's disable language...
0
7956
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 tapestry of website design and digital marketing. It's not merely about having a website; it's about crafting an immersive digital experience that...
1
7469
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 Update option using the Control Panel or Settings app; it automatically checks for updates and installs any it finds, whether you like it or not. For...
0
7808
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 protocol has its own unique characteristics and advantages, but as a user who is planning to build a smart home system, I am a bit confused by the...
0
5087
by: conductexam | last post by:
I have .net C# application in which I am extracting data from word file and save it in database particularly. To store word all data as it is I am converting the whole word file firstly in HTML and then checking html paragraph one by one. At the time of converting from word file to html my equations which are in the word document file was convert...
0
3498
by: TSSRALBI | last post by:
Hello I'm a network technician in training and I need your help. I am currently learning how to create and manage the different types of VPNs and I have a question about LAN-to-LAN VPNs. The last exercise I practiced was to create a LAN-to-LAN VPN between two Pfsense firewalls, by using IPSEC protocols. I succeeded, with both firewalls in...
1
1935
by: 6302768590 | last post by:
Hai team i want code for transfer the data from one system to another through IP address by using C# our system has to for every 5mins then we have to update the data what the data is updated we have to send another system
1
1057
muto222
by: muto222 | last post by:
How can i add a mobile payment intergratation into php mysql website.

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.