473,394 Members | 1,902 Online
Bytes | Software Development & Data Engineering Community
Post Job

Home Posts Topics Members FAQ

Join Bytes to post your question to a community of 473,394 software developers and data experts.

/// Style comments and documentation

Hi,

I have all my code commented with /// type of comments. What are my options
to generate MSDN like documentation for my code and also possibly create a
help file for my code?

Thank you,

Alan

/// <summary>
///
/// </summary>
/// <param name="procName"></param>
/// <returns></returns>
protected string GetPackageProcName(string procName)
{
Nov 17 '05 #1
3 1409
That's an easy one. http://ndoc.sourceforge.net/

Jason Newell
A.M-SG wrote:
Hi,

I have all my code commented with /// type of comments. What are my options
to generate MSDN like documentation for my code and also possibly create a
help file for my code?

Thank you,

Alan

/// <summary>
///
/// </summary>
/// <param name="procName"></param>
/// <returns></returns>
protected string GetPackageProcName(string procName)
{

Nov 17 '05 #2
You can try NDoc, an open source document generator @ ndoc.sourceforge.net.

There are other 3rd party tools as well that do the same thing.

"A.M-SG" <al******@newsgroup.nospam> wrote in message
news:Ob**************@tk2msftngp13.phx.gbl...
Hi,

I have all my code commented with /// type of comments. What are my options
to generate MSDN like documentation for my code and also possibly create a
help file for my code?

Thank you,

Alan

/// <summary>
///
/// </summary>
/// <param name="procName"></param>
/// <returns></returns>
protected string GetPackageProcName(string procName)
{

Nov 17 '05 #3
Hi Alan,

Is your problem resolved? Yes, the NDoc tool will automatically generate
documentation for your code using reflection to examine the assembly and
using the XML generated from your C# XML comments. It should meet your
need. If you have any concern, please feel free to tell me, thanks

Best regards,
Jeffrey Tan
Microsoft Online Partner Support
Get Secure! - www.microsoft.com/security
This posting is provided "as is" with no warranties and confers no rights.

Nov 17 '05 #4

This thread has been closed and replies have been disabled. Please start a new discussion.

Similar topics

5
by: point | last post by:
Anyone knows of a good and easy program or script which generates doc file from a phpdoc style comments???? PhpEdit has something like that but I need a standalone one... respect....
0
by: Greg Stangler | last post by:
Is their a utility in .NET which will convert the Java style code documentation comments: /** * Some java style comments * @param p1 ... * @returns ... */ into the C# style
4
by: lorinh | last post by:
Hi Folks, I'm trying to strip C/C++ style comments (/* ... */ or // ) from source code using Python regexps. If I don't have to worry about comments embedded in strings, it seems pretty...
1
by: jarnie | last post by:
I have the VB 2005 Express Edition, and have been looking at how to add XML Documentation to my projects. After reading a few articles I have found, it appears that 2005 introduced native support...
1
by: Alex Chun | last post by:
How can I add comments / documentation to an Access database, so that the next person programming the database will understand what s/he is looking at? For example, I might have a select query,...
2
by: beatTheDevil | last post by:
Hey guys, As the title says I'm trying to make a regular expression (regex/regexp) for use in removing the comments from code. In this case, this particular regex is meant to match /* ... */...
3
by: lex __ | last post by:
I'm tryin to use regexp to replace multi-line c-style comments (like /* this /n */ ) with /n (newlines). I tried someting like re.sub('/\*(.*)/\*' , '/n' , file) but it doesn't work for...
9
by: Mythran | last post by:
Can someone please point me to some articles explaining how to convert the code comment xml files into MSDN documentation? I've made some modifications to Enterprise Library and would like to...
5
by: NewLegend | last post by:
Hello i'm writing a class for network all works fine but when client disconnected my code can't dected it so if u can help me or say is there an error on the code i will be glad ,alot of thanks ...
0
by: Charles Arthur | last post by:
How do i turn on java script on a villaon, callus and itel keypad mobile phone
0
by: emmanuelkatto | last post by:
Hi All, I am Emmanuel katto from Uganda. I want to ask what challenges you've faced while migrating a website to cloud. Please let me know. Thanks! Emmanuel
0
BarryA
by: BarryA | last post by:
What are the essential steps and strategies outlined in the Data Structures and Algorithms (DSA) roadmap for aspiring data scientists? How can individuals effectively utilize this roadmap to progress...
1
by: nemocccc | last post by:
hello, everyone, I want to develop a software for my android phone for daily needs, any suggestions?
0
by: Hystou | last post by:
There are some requirements for setting up RAID: 1. The motherboard and BIOS support RAID configuration. 2. The motherboard has 2 or more available SATA protocol SSD/HDD slots (including MSATA, M.2...
0
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,...
0
Oralloy
by: Oralloy | last post by:
Hello folks, I am unable to find appropriate documentation on the type promotion of bit-fields when using the generalised comparison operator "<=>". The problem is that using the GNU compilers,...
0
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...
0
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...

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.