All geek questions in one place

How to format comments in C ++?

Can someone suggest a suitable comment format that I should use in a C ++ project? I think there is some analogue of javadoc , but I can not find it. Is there any de facto standard of this kind? Thank!

+3
source share
3 answers

Doxygen is used quite often for C ++ projects (Doxygen also supports other languages). You can use Doxygen-style comments as a starting point ( here are a few examples ). Just be consistent.

+17
source

Javadoc , doxygen. , C++ HTML ( ) PDF. , , Javadoc.

, .

+2

.

, Doxygen, -, Doxygen .

++ 2 :

  • /**/
  • //

I would advise against using the old style. The problem is that it does not nest, which is very annoying when for testing purposes you want to comment out the entire block of code.

My 2 cents, as they say.

+2
source

Source: https://habr.com/ru/post/1754362/

More articles:


All Articles