Home | Contact Us | FAQ | Search & Site Map | Link to Us
Sign In | Join | Other 45 Sites in Network
HomeAnnouncementsFree MagazinesWhite PapersSubmit Content
Discussion GroupsASP.NETWindows FormsLanguages.NET FrameworkVisual Studio.NET
Articles.NET FrameworkASP.NETToolsWindows Forms
.NET DirectoryOpen Source ProjectsUser GroupsWeb Resources
Related Topics
Visual Basic 6SQL ServerMS AccessOther DB ProductsMS Server ProductsMore Topics ...

.NET Forum / Visual Studio.NET / IDE / March 2005

Tip: Looking for answers? Try searching our database.

<summary> to left?

Thread view: 
Enable EMail Alerts  Start New Thread
Thread rating: 
Brian - 05 Mar 2005 15:57 GMT
Hi, I'm just having my first serious look at the VS .Net IDE after
years of VS6.

I quite like the way you can use intellisense to look at variables,
and it *almost* makes up for the jarring abscence of m_ etc :)

Anyway, I'm looking at the way you build documentation /
intellisense into the code (in this case c#).

you can do
/// <summary> blah </summary>
THIS NEXT LINE BE DOCUMENTED

but say you had a class like
class blah
{
    int widget;        /// little sentence to document widget
    int widgetsCousin; /// little sentence to document widgetsCousin
    // etc
}

.. how can I do this inline? <summary> always wants to document
whats to the RIGHT. Not whats to the left.

if you did
    int widget;  /// <summary> document widget </summary>
    int widgetsCousin;
you will end up with the documenation being attached to widgetsCousin

Is there a way to do this neatly?

I would prefer the above to:
..
    <summary>  I want to document wibble </summary>
    int widget;    
    <summary>  I want to document widgetsCousin</summary>
    int widgetsCousin;  
..

Any idea? I couldn't see how.
Cowboy \(Gregory A. Beamer\) - 06 Mar 2005 03:10 GMT
Currently, there is no built-in method for inline documentation comments. As
your methods should be "black boxes", there is no reason to document inline
comments.

Signature

Gregory A. Beamer
MVP; MCP: +I, SD, SE, DBA

*************************************************
Think outside the box!
*************************************************

> Hi, I'm just having my first serious look at the VS .Net IDE after
> years of VS6.
[quoted text clipped - 36 lines]
>
> Any idea? I couldn't see how.

Free Magazines

Get these publications absolutely FREE for up to 12 months. There are no hidden fees and no obligation. Simply choose a title, complete the application form and submit it. Read more ...

Oracle MagazineNetwork ComputingComputer WorldBio-IT WorldeWeekInformation WeekInfosecurity
 
Sign In
Join
My Latest Posts
My Monitored Threads
My Blog
My Photo Gallery
My Profile
My Homepage

Start New Thread
Enable EMail Alerts
Rate this Thread



©2008 Advenet LLC   Privacy Policy - Terms of Use
This website includes both content owned or controlled by Advenet as well as content owned or controlled by third parties.