Doxygen .dox文件中的评论

时间:2014-11-24 15:38:53

标签: comments doxygen

我有一个.dox文件,想要插入一些不会的评论 显示在实际文档中。

尝试过只使用//,Horever,当我尝试时,删除了所有文字。

/// \defgroup desc_polyhedra Polyhedra
///
// If you want to prevent that a word that corresponds to a 
// documented class is replaced by a link you should put a % in 
// front of the word.
///
/// \section Polyhedron 
///
/// A polyhedron is a solid in three dimensions with flat faces, 
/// straight edges and sharp corners or vertices. 
///
/// Amongst the many examples of polyhedra, the Cuboid and 
/// Prismatoid structures will be considered in more detail. 
/// Here is a brief summary of cuboids and prismatoids.

1 个答案:

答案 0 :(得分:1)

这里有几个选项:

  1. 使用\cond \endcond

  2. 围绕您想要的文字。
  3. 使用 //创建一个完全独立的评论部分 - 即不要在//部分的中间混合/// 。您看到的是第一个//结束了doxygen注释块,因此它会在输出中停止显示。

  4. 在doxygen部分/// <--! A comment is here -->

  5. 中使用HTML注释语法