如何在KDoc中链接本地文件,使其在Android Studio中可点击打开?
在KDoc中链接本地文件的正确方式
要在KDoc里实现点击直接打开本地文件,你需要用以下两种正确写法:
1. 使用完整的file:///协议绝对路径
注意路径开头是三个斜杠,之前你写的file:/少了两个,导致解析失败。示例:
/** * [查看本地文档](file:///Users/yourname/Projects/MyApp/docs/ourDocs.md) */
Windows系统下路径格式示例:
/** * [查看本地文档](file:///C:/Users/yourname/Projects/MyApp/docs/ourDocs.md) */
2. 使用项目根目录占位符$PROJECT_DIR$(推荐)
这种方式不用写死绝对路径,适配项目迁移后的路径变化,Android Studio能自动识别这个占位符并解析到项目根目录。示例:
/** * [查看项目内文档]($PROJECT_DIR$/docs/ourDocs.md) */
注意事项
- 路径要准确对应文件在项目中的位置,Linux/mac系统下路径区分大小写
- 确保目标文件确实存在,否则点击链接会提示找不到文件
内容的提问来源于stack exchange,提问作者Max
相关产品推荐
相关产品推荐

