我的库的所有类都是在命名空间内定义的。当我为 Doxygen 创建主页时,我必须在注释中显式使用此命名空间以使 Doxygen 生成链接。我想对整个评论块使用类似“使用命名空间”的内容。
一个例子:
/**
* \mainpage My Library
*
* Use MyLibraryNamespace::MyClass to ...
*/
这里 Doxygen 自动生成一个指向 MyLibraryNamespace::MyClass 文档的链接。
/**
* \mainpage My Library
*
* Use MyClass to ...
*/
这里 Doxygen 不会生成指向 MyLibraryNamespace::MyClass 文档的链接(因为我认为不同的命名空间中可能有多个 MyClass 定义)。为了方便阅读,我想省略注释中的名称空间前缀。是否可以无需输入\ref MyLibraryNamespace::MyClass "MyClass"
每次?
你可以让这个工作为一个命名空间将您的评论放入命名空间中。这让我很烦恼,因为我们有多个嵌套的命名空间,而且我讨厌在 Doxygen 注释中使用它们。
namespace MyLibraryNamespace {
/**
* \mainpage My Library
*
* Use MyClass to ...
*/
};
从 Markdown 角度看 2016 年更新
我将 Doxygen 用于 Realm 的 C# 文档(是的,Doxygen 也处理典型的 C# XML 注释格式!)。 Markdown 主页使用 @ref 来引用命名空间类:
The main classes you will use are:
- [Realm](@ref Realms.Realm)
- [RealmObject](@ref Realms.RealmObject)
- [RealmList](@ref Realms.RealmList)
- [Transaction](@ref Realms.Transaction)
您可以看到渲染版本在线这里 https://realm.io/docs/xamarin/latest/api/
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)