473,569 Members | 2,700 Online
Bytes | Software Development & Data Engineering Community
+ Post

Home Posts Topics Members FAQ

Is there such C# tool ?

I have .cs source file with a bunch of public and internal members
(classes, methods, enums ...) in it.
I want to extract declarations of public members into separate file
so that I can distribute this file among users as documentation.

Is there such tool to extract public members form .cs source file ?

Oleg Subachev
Mar 23 '06 #1
4 1395
Oleg,

have you tried the build comment web pages menu command on the tools menu?

I find this tool particular useful for creating my documentation, it does
however depend on you entering useful or descriptive comments in your code.

Regards
Scott Blood
C# Developer
"Oleg Subachev" <ol**@urvb.ru > wrote in message
news:Om******** ******@TK2MSFTN GP14.phx.gbl...
I have .cs source file with a bunch of public and internal members
(classes, methods, enums ...) in it.
I want to extract declarations of public members into separate file
so that I can distribute this file among users as documentation.

Is there such tool to extract public members form .cs source file ?

Oleg Subachev

Mar 23 '06 #2
take a look at ndoc (ndoc.sf.net), unfortunately it does not support
..NET 2.0 at the moment but there is an upcoming version that does, ETA
for that version however is unknown..

Mar 23 '06 #3
If that is all you need, check out the Ildasm.exe command-line tool that
comes with the .Net framework.

--
HTH,

Kevin Spencer
Microsoft MVP
Professional Numbskull

Show me your certification without works,
and I'll show my certification
*by* my works.

"Oleg Subachev" <ol**@urvb.ru > wrote in message
news:Om******** ******@TK2MSFTN GP14.phx.gbl...
I have .cs source file with a bunch of public and internal members
(classes, methods, enums ...) in it.
I want to extract declarations of public members into separate file
so that I can distribute this file among users as documentation.

Is there such tool to extract public members form .cs source file ?

Oleg Subachev

Mar 23 '06 #4
Oleg,

That what the doc comments are for. Document you source code using doc
comments and then use one of tools for generating help files. There is one
free, very good, but at the moment I don't remember its name; I can look
around for it if you need it.
--
HTH
Stoitcho Goutsev (100)

"Kevin Spencer" <ke***@DIESPAMM ERSDIEtakempis. com> wrote in message
news:u2******** ******@TK2MSFTN GP12.phx.gbl...
If that is all you need, check out the Ildasm.exe command-line tool that
comes with the .Net framework.

--
HTH,

Kevin Spencer
Microsoft MVP
Professional Numbskull

Show me your certification without works,
and I'll show my certification
*by* my works.

"Oleg Subachev" <ol**@urvb.ru > wrote in message
news:Om******** ******@TK2MSFTN GP14.phx.gbl...
I have .cs source file with a bunch of public and internal members
(classes, methods, enums ...) in it.
I want to extract declarations of public members into separate file
so that I can distribute this file among users as documentation.

Is there such tool to extract public members form .cs source file ?

Oleg Subachev


Mar 23 '06 #5

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

Similar topics

1
3202
by: Vandana Rola | last post by:
Hello Everyone, We are using javascript's tooltip (pop up on mouse over )function. The problem we are having is as we go scroll two or three pages deep in to the html page our tool tip /pop up gets farther away from the position where it is supposed to be. It happens to the extend that at certain point we don't see the tool tip at all. ...
6
2998
by: d.warnermurray | last post by:
I am doing a project for school that involves creating help files for a html authoring tool. If you could help me with answers to some questions it would really help. 1. What tasks do you expect an html authoring tool to help you accomplish? 2. What do you expect from online help for a html authoring tool? 3. What audience do you think...
16
15944
by: jblankenburg | last post by:
I am trying to deploy a simple web application to my client's production server, but it's not clear to me how MS planned on having the Security users managed without Studio. Certainly someone has run into this issue. How do you manage users (the ones you would normally manage with the Web Site Administration Tool) without Studio to get you...
0
1794
by: CharlesA | last post by:
sorry I had to clarify my previous post as I wasn't able to get specific answers so I'm made this very targetted to what I actually pretty desperate to fix. my Setup: I've got XP pro, IIS 5 , visual Studio 2005, asp.net 2.0 and C#, I have SQL server 2005 installed as well. if I create a web site with the internal web server of VS2005,...
22
3266
by: David T. Ashley | last post by:
I'm writing code which will compile on multiple Windows and multiple *nix platforms. Some will have 64-bit integers, I believe. What is my best option to define platform-independent types such as UINT32 or UINT64? I'm not sure how to sort out the various platforms and integer sizes, and some of it may even vary based on compiler options. ...
5
2342
by: TonyJ | last post by:
Hello!! Is it anyone that have some experience using a good case tool that support C# design in using UML. For example reverse engineering. I have used the together case tool when I worked with the Java language. //Tony
1
9993
by: JeanDean | last post by:
I have successfully installed the valgrind-3.2.3 but it is resulting in following error ------------------------- valgrind ls -l valgrind: failed to start tool 'memcheck' for platform 'x86-linux': No such file or directory -------------------------- Any sort of suggestion will be appreciated .
4
2293
by: Mike Bromwich | last post by:
Hi Our product can interact with a number of third party assemblies, as long as the customer has purchased and installed these libraries. We do not want to add references to these assemblies into our solution, since this stops the product from running if the assemblies are not present. We could change our product to call the third-party...
2
9574
by: tvnaidu | last post by:
valgrind error - "failed to start tool 'memcheck' for platform x86-linux" no such file or dir copied all lib and bin files which are generated after I compiled valgrind package, when I run my exe with valgrind, I am getting above error, any idea? lib/ -rw-r--r-- 1 0 0 27934 default.supp -rwxr-xr-x 1 0 0 ...
0
7612
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
7924
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, it seems that the internal comparison operator "<=>" tries to promote arguments from unsigned to signed. This is as boiled down as I can make it. ...
0
8122
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...
0
7970
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
6284
agi2029
by: agi2029 | last post by:
Let's talk about the concept of autonomous AI software engineers and no-code agents. These AIs are designed to manage the entire lifecycle of a software development project—planning, coding, testing, and deployment—without human intervention. Imagine an AI that can take a project description, break it down, write the code, debug it, and then...
0
5219
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
3640
by: adsilva | last post by:
A Windows Forms form does not have the event Unload, like VB6. What one acts like?
1
2113
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
0
937
bsmnconsultancy
by: bsmnconsultancy | last post by:
In today's digital era, a well-designed website is crucial for businesses looking to succeed. Whether you're a small business owner or a large corporation in Toronto, having a strong online presence can significantly impact your brand's success. BSMN Consultancy, a leader in Website Development in Toronto offers valuable insights into creating...

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.