我正在记录这个类,但在Appledoc或Doxygen方面运气不佳。对于这个问题,我想集中讨论一下Doxygen的问题。
Doxygen将列出(忽略)类级别的介绍-我的意思是,如果接口中的代码片段也包含接口或协议,则出现在@interface上方的所有位。为了正确地记录这个类,我们确实需要这些片段。
有没有一种方法可以让doxygen将这些代码片段视为片段和普通片段,而不去掉类概述?
我试过使用一些围栏符号,但没有成功。
这是它最终的样子。
有两种方法可以解决这个问题:
使用以下标签告诉Doxygen代码片段如下:
@code
@endcode
另一个选项是sse@include指令,并为设置一个examples文件夹,将其作为独立文件包含
在此之前,我使用了缩进代码块的标记样式语法。为了实现这一点,我不得不用反斜杠转义以下符号:"@"、"<"和'>'。从技术上讲,这是一个错误,因为doxygen应该将缩进视为一个代码块。Doxygen团队已经对此进行了记录。