QDoc建立链接 - 让您的文档更加完整
在编写文档时,我们经常需要引用其他页面或文件中的内容,而QDoc提供了一种方便快捷地建立链接的方式,让您的文档更加完整。
要在QDoc中建立链接,首先需要确定目标页面或文件的相对路径。假设我们要在当前页面中建立到另一个页面的链接,而这个页面位于与当前页面同级的目录下,那么可以使用如下的语法:
\ref <relative_path/to/target_page>
其中,<relative_path/to/target_page>就是目标页面相对于当前页面的路径。例如,如果目标页面名为target.html,而且与当前页面处于同一目录中,那么可以使用以下代码创建链接:
\ref target.html
此外,还可以在引用前加上@符号,来显示目标页面的标题(如果有的话),例如:
\ref @target.html
以上代码将会在文档中生成类似于“参见Target Page”的链接文字,点击该链接将会跳转到目标页面。
如果您需要引用其他类型的文件,比如图片、代码文件等等,同样可以使用上述语法。只需要将目标文件的路径替换到<relative_path/to/target_page>中即可。例如:
\image <relative_path/to/image_file>
\code <relative_
本文档介绍了如何使用QDoc创建链接,以便在文档中引用其他页面或文件内容,提升文档的完整性和易读性。通过指定目标文件的相对路径,可以创建到同级目录下页面的链接,并可显示目标页面的标题。此方法同样适用于图片和代码文件等其他类型的文件引用。
订阅专栏 解锁全文
107

被折叠的 条评论
为什么被折叠?



