开发者

funny looking comments - c++

开发者 https://www.devze.com 2022-12-24 03:55 出处:网络
when i read through source files of opensource projects i often come across some weird phrases in the comments开发者_如何学C

when i read through source files of opensource projects i often come across some weird phrases in the comments

开发者_如何学C
/*       
@brief ......  
@usage.....  
@remarks....  
@par....  
*/

questions

1.What are they?(were not mentioned when i was learning c++)

2.Do they have any documentation(where)


They are just comments and as such have no special meaning in C++. They are probably to allow a documentation generator (For example Doxygen) to extract the data from the comments.


Those are for some flavour of automatic documentation generator. Another program runs through the code looking for comments of like you see there. The @... keywords identify how the documentation should be laid out, and that program generates pretty HTML or printed documentation directly from the source code. It's a way to keep the docs up-to-date with the code more easily.

0

精彩评论

暂无评论...
验证码 换一张
取 消

关注公众号