This may sound like a really dumb question. But I can’t seem to find it
anywhere on the internet.
Say that you are coding in Visual Studio, sometimes when you select a
method, and InteliSense pops up, you can see which parameters are needed
in a yellow-ish box.
Sometimes though, there is a text commenting the method in this same
How do you write these comments?
I’m writing some generic library for some friends of mine (for easy use)
I would like to comment my code decently. It would be nice if they
could see this comment by just hovering over it in InteliSense :)
Please log in or register to post a reply.
It just extracts it from the header file where the method is defined; if
there’s a comment above the method, or on the same line as the method,
it’ll (hopefully) pick that up.
Depends on your version of VS (Esp. Express vs not) and language.
For c#, it’s
old, but a
For C++, it’s a bit
Wauw. I had never seen the xml documentation before. This is really
Anyone has any recomendations for which program to use to transform the
XML file into useful help/docu file?
Doxygen is one of the best ones
out there. It supports many forms of commenting formats and programming
languages. If you install graphviz in
addition to Doxygen, you can produce class relationship diagrams. By
default Doxygen will write HTML files, but you can export to RTF or my
personal fav, CHM (compiled HTML).
Doxygen did the trick. Thanks alot !
Frankly this can be acheived as easily as a triple slash ( /// ) which
will automatically expand to the format required, then you just fill in