如何在Kotlin类的块注释中指定XML文件?
在Kotlin块注释中引用Android XML文件的方法
其实Kotlin的KDoc(也就是你用的块注释/** ... */)默认并没有专门针对XML资源的直接引用语法,不过我们可以用几种小技巧让IDE(比如Android Studio)识别并支持跳转,完美解决你的需求:
使用
@see标签配合完整文件路径
你可以直接在注释里通过@see指定XML文件的相对路径,Android Studio会自动识别这个路径并提供跳转支持,写法如下:/** * 导航流程的详细定义请参考 * @see res/navigation/nav_graph.xml */ class MainNavigationHandler { // ... }注意路径要和你的项目结构对应,比如如果是放在
res/layout下的布局文件,就写res/layout/activity_main.xml。用代码标记文件名+路径说明
如果不想用@see,也可以直接在注释里用反引号标记文件名,同时补充路径提示,IDE同样能识别路径并允许跳转:/** * 页面的导航逻辑全部定义在 `nav_graph.xml` 中 * 路径:app/src/main/res/navigation/ */ fun setupNavigation() { // ... }直接写完整项目路径
更稳妥的方式是写出从项目根目录开始的完整路径,这样不管你的类放在哪个模块下,IDE都能精准定位到XML文件:/** * 查看完整的导航配置请打开:`app/src/main/res/navigation/nav_graph.xml` */
简单来说,核心就是给IDE提供明确的文件路径,因为KDoc本身是为Kotlin代码设计的,XML属于资源文件,需要通过路径让IDE关联到对应的文件~
内容的提问来源于stack exchange,提问作者Wahib Ul Haq
相关产品推荐
相关产品推荐

