Code documentig(commenting)

[Chiz]

How to document or comment code in Qt? Is there smth like in Java or C#?
I want to describe methods, classes. And after this I want to generate documentation about my classes.
Please, give me a proper link where I can read about this.


Sorry. Not full question.
I want in IDE (in my situation Eclipse) after input method IDE show me input params...
See, please, attached screenshots. It's hard for me to describe using words...

example_1.JPG
example_2.JPG
example_3.jpg

Can I achive such behaviour for Qt? On screenshots J2ME project.

[high_flyer]

See doxygen.

[squidge]

I agree. Doxygen is an excellent code documentation tool.

[high_flyer]

Can I achive such behaviour for Qt? On screenshots J2ME project.

What you are showing is an IDE feature, it has nothing to do with Qt.
I think that QtCreator has a similar feature, but since I hardly used, I can't tell for sure.
Visual Assist will do that for VisualStudio.

[nroberts]

You might consider the concept of 'self-documenting code'. This means coding with small, well named functions and objects, that are documented by their very existence and names.

See:

http://c2.com/cgi/wiki?ToNeedComments

http://c2.com/cgi/wiki?TooMuchDocumentation

http://memeagora.blogspot.com/2008/1...ode-smell.html

etc...

Also, I've found that one apparently decent way to instruct someone on a new code-base is to tell them to go document it.