2

I don't want to put XML comments or anything in source code.

I want to do something like this:

  1. Click add class - type name
  2. Click add method - type name
  3. Add description, images, etc.

2 Answers 2

3

You can do that, you know the XML comments in C# are supported by the compiler, the output is this XML and it's just XML.

You could build a simple tool for that, using reflection. It's a good exercise to learn more about reflection and the .NET type system.

Though, I would actually advice against it because having the source code and documentation in one place makes it easier to adhere to the DRY principle. You don't want your documentation and source code drifting apart and you can always collapse the comments (that way, they don't show up when your editing the source code). And you documentation will then be under source control as well.

Sign up to request clarification or add additional context in comments.

Comments

2

Sandcastle makes nice msdn like help files from xml code.

Tutorial

Update

I am sorry for my missleading answer. You can try Adobe Robocop. We used it to make high quality chm files even with animated gif.

3 Comments

I asked about tool that makes documentation NOT from source code. I mean I write docs manually. I can add graphics and more.
Sorry about that - I updatet my answer to give you another shot
Finally I made documentation in source code + Sandcastle.

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service and acknowledge you have read our privacy policy.

Start asking to get answers

Find the answer to your question by asking.

Ask question

Explore related questions

See similar questions with these tags.