【问题标题】:Doxygen in TCL missing @endcode tagTCL 中的 Doxygen 缺少 @endcode 标记
【发布时间】:2014-02-04 13:40:40
【问题描述】:

我有以下 TCL 代码,我得到一个“在 @code 块内到达注释的结尾;检查是否缺少 @endcode 标记!”在“proc :: IniGuiValues { } {

之后的空白行中

#\endcode 在 proc 的右大括号之后。我不明白为什么..

  ## For: Something
  # 
  # This proc initializes the GUI with meaningful values.
  # 
  # \arg \c PROC HAS NO ARGUMENTS.
  # \return PROC HAS NO RETURNVALUES
  # \todo Harmonize var names
  # \code
  proc ::IniGuiValues { } {
  THIS LINE IS BLANK
    set err [ catch { set LCIds [getSubcaseList] } res ]          
      if { $err == 0 } {
          set ::GUI_LCs $LCIds
      } 

【问题讨论】:

  • 结束代码未出现在您问题中包含的示例中。我发现这是对 code 命令的不寻常使用,你想做什么?
  • 实际中右大括号正下方的#\endcode。我希望这个过程的整个代码显示在文档中。有这么不寻常吗?
  • 只是通常您在评论本身中使用代码sn-p,而不是使用实时代码作为评论。在您拥有endcode 之前,您已经到达了 doxygen 评论块的末尾。

标签: tcl doxygen


【解决方案1】:

您正在分解 endcode 命令之前的注释块。

## For: Something
# 
# This proc initializes the GUI with meaningful values.
# 
# \arg \c PROC HAS NO ARGUMENTS.
# \return PROC HAS NO RETURNVALUES
# \todo Harmonize var names
# \code
# proc ::IniGuiValues { } {
# THIS LINE IS BLANK
# set err [ catch { set LCIds [getSubcaseList] } res ]          
#   if { $err == 0 } {
#     set ::GUI_LCs $LCIds
#   } 
# \endcode
proc ::IniGuiValues { } {
THIS LINE IS BLANK
set err [ catch { set LCIds [getSubcaseList] } res ]          
  if { $err == 0 } {
      set ::GUI_LCs $LCIds
  } 

【讨论】:

猜你喜欢
  • 1970-01-01
  • 1970-01-01
  • 2011-05-23
  • 1970-01-01
  • 1970-01-01
  • 2021-09-22
  • 2018-12-01
  • 2021-12-26
  • 1970-01-01
相关资源
最近更新 更多