块结构

• 象文章分章节一样
• 注释文本也能定义各种语义区块

段落

• @par 命令引出

•  /*! \class Test
      普通文字
      
      @par    用户定义第一段.
      段落可以包含多行
      
      @par    这是第二段. 段落间通过空行来区分
   */

• 具体实例参考:

  • @par 命令

  • 输出的HTML

列表

• @li 命令引发
• 可以混合其它格式命令

•   @li \c AlignLeft left alignment.
    @li \c AlignCenter center alignment.
    @li \c AlignRight right alignment
    
    无类型的列表项也支持

• 具体实例参考:

  • @li 命令

章节

• @section 命令引发
• 不过，只能在 @page 命令后作用
• 即通过 @page 命令，声明创建一个相关页面，内容将组织到最终的“相关页面”中，与 Todo Bug 列表页面等等并列在一起!

• 例如

   /*! @page page1 A documentation page
    Leading text.
    @section sec An example section
    This page contains the subsections \ref subsection1 and \ref subsection2.
    For more info see page \ref page2.
    @subsection subsection1 The first subsection
    Text.
    @subsection subsection2 The second subsection
    More text.
  */
  
  /*! @page page2 Another page
    Even more info.
  */

• 将生成:

  • @page 命令

  • 包含了

    • @section 章

    • @subsection 节

    • @ref 提及 三个命令的使用

引用块

• @code 和 @endcode 框出

• 类似:

  • /*!
    ...
    @par _doAllOnLoad()
    @param  全局数组 g_onload
    @return void 逐条调用已知的函数^_^
    
    @note   动态加载的模块中,一些函数需要onLoad()事件触发;但是
    @code   window.onload= new Function ("myFunctoin();");
    @endcode
    
    将会重新注册 onLoad() 事件的运行函数,致使不能简单的使不同的模块中需要的不确定数目的 onLoad()触发函数叠加注册!
    ...
    */

行内修饰

• 简单的字体声明

@b

• @b 文字

• 生成:

  • <b>文字</b>

@c

• @c 文字

• 生成:

  • <tt>文字</tt>

@n

• @n

• 生成:

  • <br/>

特殊标签

• 针对PHP语言，doxygen 有几个标签命令，需要关注

PHP代码说明专用

• @private 私有的

• @protected 保护的

• @public 公开的

• 是独立说明项的声明标签
• 用以说明 类/函式/变量 的具体性质

PHP章节内容专用

• @privatesection 私有的章节

• @protectedsection 保护的章节

• @publicsection 公开的章节

• 是@page 附加说明页面内容中的声明标签

• 用以领起不同性质的 类/函式/变量 说明内容

警告

• 当然对于意外情况， doxygen 不会崩溃，只是进行警告，你可以根据log 日志文件的提示进行修正

ZoomQuiet (2005-01-27)