Code documentation practices

10 Aug 2006 3:19 PM

maflatoun

Hi everyone,

Our company is growing rapidly and I have been hiring people to help me
out with our ASP.NET development. I like to put in place some code
documentation standards. I've been reading a little on what is required
for documentating and it breaks down into two parts.

Part 1 - Inline code description
Part 2 - Project description

Does anyone know a site/article/book that would explain how to properly
document your code and project? (maybe with example). Your feedback is
greatly appreciated.

Thanks
M.

10 Aug 2006 3:36 PM

Kevin Spencer

If you have Visual Studio.Net. use XML Code Comments. Here's a good starting
point:

http://msdn.microsoft.com/msdnmag/issues/02/06/XMLC/

--
HTH,

Kevin Spencer
Microsoft MVP
Chicken Salad Surgery

Accept the Unexpected.

<maflat***@gmail.com> wrote in message

Show quote

news:1155223190.230669.166020@m73g2000cwd.googlegroups.com...
> Hi everyone,
>
> Our company is growing rapidly and I have been hiring people to help me
> out with our ASP.NET development. I like to put in place some code
> documentation standards. I've been reading a little on what is required
> for documentating and it breaks down into two parts.
>
> Part 1 - Inline code description
> Part 2 - Project description
>
> Does anyone know a site/article/book that would explain how to properly
> document your code and project? (maybe with example). Your feedback is
> greatly appreciated.
>
> Thanks
> M.
>

10 Aug 2006 7:59 PM

sloan

Check out GhostDoc ...
http://www.roland-weigelt.de/ghostdoc/

...

<maflat***@gmail.com> wrote in message
Show quote

news:1155223190.230669.166020@m73g2000cwd.googlegroups.com...
> Hi everyone,
>
> Our company is growing rapidly and I have been hiring people to help me
> out with our ASP.NET development. I like to put in place some code
> documentation standards. I've been reading a little on what is required
> for documentating and it breaks down into two parts.
>
> Part 1 - Inline code description
> Part 2 - Project description
>
> Does anyone know a site/article/book that would explain how to properly
> document your code and project? (maybe with example). Your feedback is
> greatly appreciated.
>
> Thanks
> M.
>