2014-09-04 1220 views
0

Eclipse的內置幫助顯示@a@c的一些方法,這裏有一個例子:文檔字符串中的@a,@c是什麼意思?

@remarks這將創建像elm_win_add()一個窗口,而且還把使用elm_bg_add()一個 標準的背景,以及設置窗口 標題爲@a標題。創建的窗口類型爲@c ELM_WIN_BASIC@c NULL作爲父窗口小部件。

@a@c是什麼意思?

回答

2

看起來像JavaDoc風格的標記,它也支持Doxygen。

the doxygen documentation

在文檔開始以反斜槓(\)或者在符號(@)的所有命令。
...

\a <word>
顯示斜體的說法。使用此命令強調單詞。使用此命令來引用正在運行的文本中的成員參數。

\c <word>
顯示使用打印字體的論點。用它來指代一個代碼的詞。相當於< tt>字</tt>。

+0

不認爲它與您解釋的相同,因爲它也包含@remarks,@a和@c – AshS 2014-09-18 13:45:59

+0

我不確定爲什麼您認爲這很重要(?)。 doxygen文檔甚至會提到_「開始可以輸入一個或多個備註的段落......所有視覺增強命令都可以在段落內部使用。」_。 – Michael 2014-09-18 14:11:54

+0

我誤解了它,更多的閱讀後,我發現這可能是一個類似的文件,如上面解釋,謝謝你清除我的疑問。 – AshS 2014-09-25 12:51:55

相關問題