28 replies to this topic

[Panarchy]

Hi

Was reading Sams Teach Yourself C++ in One Hour a Day, when I came across the following 'note';

Quote

NOTE

A third style of comment is supported by some C++ compilers. These comments are referred to as document comments and are indicated using three forward slashes (///). The compilers that support this style of comment allow you to generate documentation about the program from these comments. Because these are not currently a part of the C++ standard, they are not covered here.

This book is very recent (Copyright 2009, First Printing July 2008).

So I now I have two questions about this;

• This 3rd style of commenting, which C++ compilers support it?
  
• Is there talk of making this part of the C++ standard, and if so, please give me a link!
  
• Is Document Comments the official name for this?

Please answer my questions.

Thanks in advance,

Panarchy

[dcs]

I don't know about compilers that support such, but I tend to use Javadoc comments because my IDE does -- although I'm hoping they add doxygen as well.

Comparison of documentation generators - Wikipedia, the free encyclopedia

[Panarchy]

Okay.

What IDE do you use?

[dcs]

I use SlickEdit.

[Panarchy]

Ah, Okay!

[Xav]

/// adds the line of code to an XML file, which allows you to build documentation.

[Panarchy]

And when will the /// be built into C++?

(see 1st post)

[dcs]

Comments are not built into code.

[Xav]

I think he meant "when will the /// be implemented into the C++ syntax".

[WingedPanther]

// makes everything that follows a comment, including the third /. Producing documentation is a compiler feature, not a language feature.

[Xav]

When the compiler reads a /// line, it puts the comments into an XML file, to be used as documentation.

[Panarchy]

Okay