如何查看开源库源码Docstring中@sample标注对应的示例代码?
查找Kotlin/Compose源码中
@sample标注对应示例的实操方法 @sample是Kotlin Dokka文档工具链专用的文档标注,作用是指向项目源码中专门用于展示API用法的示例类,标注里的字符串就是示例类的全限定包名+类名,比如例子里的@sample androidx.compose.foundation.samples.PlaceholderBasicTextFieldSample,指向的就是完整类路径为androidx.compose.foundation.samples.PlaceholderBasicTextFieldSample的示例实现。
方法1:在开源源码仓库全局匹配类名定位
- 所有带
@sample关联的示例类,都会统一放在对应库模块的src/sample、src/commonSample这类独立的示例源码目录下,不会和主功能业务代码混放 - 要查找指定示例时,直接在对应库的公开源码仓库中,搜索示例类的全名(比如本次要找的
PlaceholderBasicTextFieldSample),就能直接定位到存放示例代码的.kt文件,打开即可看到完整实现 - 注意:正式发布到Maven仓库的AAR/JAR依赖包中,不会打包存放samples目录下的示例代码,这部分内容仅在源码仓库和文档生成资源中存在,直接在本地编译依赖包里搜索是找不到的
方法2:借助IDE原生导航功能跳转
- 如果本地项目已经关联了对应版本的依赖源码,将光标放在
@sample后面的全限定类名字符串上,按下IDE默认的代码跳转快捷键(IDEA/Android Studio为Windows/Linux端Ctrl+B、macOS端Cmd+B),IDE会自动解析类路径并跳转到对应的示例源码位置 - 如果跳转失败,可在IDE的依赖管理面板中,找到对应版本的库,手动触发源码包下载,完成后即可正常跳转
方法3:从官方生成的在线文档中读取内嵌示例
- 带
@sample标注的项目在生成官方在线文档时,会自动把对应示例的完整代码内嵌到对应API的说明区块下方 - 直接检索目标API的文档页面,找到对应的代码展示区,看到的内容就和源码中的示例实现完全一致
常见踩坑提示:部分早期版本的开源库会将示例代码单独打包为独立的Maven构件,不会附带在主功能依赖中,这类情况在本地项目环境里是无法通过导航功能找到示例类的,必须直接到源码仓库的samples目录下检索对应内容。
内容的提问来源于stack exchange,提问作者Alexander
相关产品推荐
相关产品推荐

