Re: Ideas on commenting code ..

Tech Tip: Click here to run a free scan for Windows Errors and optimize PC performance

From: Bob Powell [MVP] (bob_at__spamkiller_bobpowell.net)
Date: 10/23/04 

Date: Sat, 23 Oct 2004 12:05:33 +0200

I recently wrote a snippet in my blog that deals with this. There is a C#
example available which illustrates the styles I use. I have been creating
developer tools that provide source code for over eight years now so I'm
used to having people looking at my stuff.

I use NDoc to take the generated XML and format it into an MSDN style help
file. I find this method very effective.

http://bobpowelldotnet.blogspot.com/ 

-- 
Bob Powell [MVP]
Visual C#, System.Drawing
Answer those GDI+ questions with the GDI+ FAQ
http://www.bobpowell.net/gdiplus_faq.htm
The GDI+ FAQ RSS feed: http://www.bobpowell.net/faqfeed.xml
Windows Forms Tips and Tricks RSS: http://www.bobpowell.net/tipstricks.xml
Bob's Blog: http://bobpowelldotnet.blogspot.com/atom.xml
"Anders Borum" <a@b.dk> wrote in message
news:e$gZP6HuEHA.2596@TK2MSFTNGP15.phx.gbl...
> Hello!
>
> I was wondering if there are any guidelines to documenting our C# code?
>
> I'm not talking about the actual syntax for the Xml markup we add to the
> classes, methods etc., but general guidelines for how the text should be
> presented (aside from looking at the .NET framework obviously)?
>
> -- 
> venlig hilsen / with regards
> anders borum
> --
>
>

Relevant Pages

  • Re: GDI/Screen capture
    ... The standard GDI is the only way to go for now. ... Watch my blog and I'll post the ... Justin Rogers ... >>> lpDriverName As String, ByVal lpDeviceName As String, ByVal lpOutput As ...
    (microsoft.public.dotnet.framework.drawing)
  • Re: GDI+ FAQ offline
    ... Answer those GDI+ questions with the GDI+ FAQ ... Pick up the feed for my blog if you're> interested in knowing when it's back up again. ... > Bob Powell [MVP] ...
    (microsoft.public.dotnet.framework.drawing)
  • Re: grid world and discrete (aliased) lines
    ... Answer those GDI+ questions with the GDI+ FAQ ... Read my Blog at http://bobpowelldotnet.blogspot.com ... you have a 100x100 pixels ... > I would like to draw a line in this discrete space, ...
    (microsoft.public.dotnet.framework.drawing)
  • Re: grid world and discrete (aliased) lines
    ... Answer those GDI+ questions with the GDI+ FAQ ... Read my Blog at http://bobpowelldotnet.blogspot.com ... you have a 100x100 pixels ... > I would like to draw a line in this discrete space, ...
    (microsoft.public.dotnet.languages.csharp)