Kotlinx-Knit: Kotlin代码文档管理工具
Kotlinx-Knit是一个Kotlin源代码文档管理工具,生成Kotlin源示例文件,并通过带有Kotlin代码的嵌入式摘要的Markdown文档进行测试。它支持在文档中添加API文档网站的链接,并提供其他有用的文档管理功能。Knit工具是一个插件,能够处理.kt、.kts文件中的KDoc注释,并更新相关的Markdown文件(.md),同时编写其他示例和测试文件,并提交到版本控制系统(VCS)。总体工作流程包括在Markdown文件或源文件中编写或更新文档,运行gradlew knit以更新文件并生成其他代码示例和测试,最后将更新提交到VCS。生成的文件将在后续项目构建中自动验证。Knit工具不解析Markdown格式或HTML,但支持特定的Knit标记模式。
131.7KB
文件大小:
评论区