文件名称:doc-extract:Go工具,用于从特殊标记的Go注释中提取文本
文件大小:13KB
文件格式:ZIP
更新时间:2024-05-21 00:43:34
go golang extract sphinx api-blueprint
文档提取 doc-extract是用于在Go源代码中提取带有特殊标记的注释的工具。 带标签的注释以包含+extract的空白行开头。 支持分组行注释( // )和块注释( /* */ )。 安装 转到1.16和更高版本: go install github.com/joeshaw/doc-extract@latest 转到1.15和更早版本: go get -u github.com/joeshaw/doc-extract 用法 只需使用+extract作为注释的第一行,即可在Go源代码中标记注释。 例如, package main // +extract // API Documentation // ================= // // (TODO: add documentation) 然后运行doc-extract命令,为它提供Go源文件目录和输出文件: doc
【文件预览】:
doc-extract-master
----go.mod(47B)
----LICENSE(1KB)
----testdata()
--------doc.go(85B)
--------a.go(58B)
--------testdata.go(62B)
--------z.go(88B)
----README.md(2KB)
----example()
--------example.html(24KB)
--------example.go(2KB)
--------README.md(712B)
--------example.apib(489B)
----parser.go(2KB)
----parser_test.go(2KB)