使用Go語(yǔ)言編寫(xiě)一個(gè)毫秒級(jí)生成組件庫(kù)文檔工具
在開(kāi)發(fā)組件庫(kù)的過(guò)程中,文檔無(wú)疑是不可或缺的一環(huán)。優(yōu)質(zhì)的文檔可以極大地提高組件庫(kù)的可用性和可維護(hù)性。然而,傳統(tǒng)的文檔編寫(xiě)和維護(hù)方式通常是一項(xiàng)耗時(shí)且繁瑣的任務(wù)。這些傳統(tǒng)文檔生成工具通?;贘avaScript開(kāi)發(fā),速度上并沒(méi)有明顯的優(yōu)勢(shì)。
在本文中,我將嘗試將Go語(yǔ)言與前端技術(shù)巧妙融合,以創(chuàng)建一款能在毫秒級(jí)別完成文檔生成的工具。
鑒于代碼量龐大,本文中的代碼部分將主要以函數(shù)簽名和注釋的形式呈現(xiàn),而不涉及具體實(shí)現(xiàn)細(xì)節(jié)。我們將深入研究以下六個(gè)主要部分:
- 命令行工具: 文檔生成的啟動(dòng)入口。
- 任務(wù)流管理(并行串行任務(wù)): 高效地管理文檔生成任務(wù),包括并行和串行執(zhí)行。
- Markdown文檔解析: 從Markdown格式的文檔中提取信息并轉(zhuǎn)化為可用的HTML格式。
- 文檔元數(shù)據(jù)收集: 從文檔中提取關(guān)鍵元數(shù)據(jù),如位置信息,排序信息,分類(lèi)信息。
- 文檔錨點(diǎn): 用于導(dǎo)航和快速跳轉(zhuǎn)的錨點(diǎn),提升用戶(hù)體驗(yàn)。
- 文檔生成: 最終生成組件庫(kù)文檔的核心部分。
命令行工具
為了確保我們的生成工具能夠輕松地進(jìn)行打包和使用,我將其設(shè)計(jì)成了一個(gè)命令行工具。這使得將來(lái)可以方便地將工具包裝成npm包。我選擇了使用github.com/spf13/cobra庫(kù)來(lái)構(gòu)建命令行工具,以便更好地管理命令和參數(shù)。
相關(guān)代碼如下:
var rootCommand = &cobra.Command{
Use: "nk",
Short: "nk: 一個(gè)神奇的文檔生成工具",
Long: "nk是一個(gè)強(qiáng)大的文檔生成工具,旨在提供快速而高效的文檔生成體驗(yàn)。",
}
var generateCommand = &cobra.Command{
Use: "generate",
Aliases: []string{"g"},
Short: "generate: 啟動(dòng)文檔生成",
Long: "generate命令用于啟動(dòng)文檔生成。",
}
var docCommand = &cobra.Command{
Use: "doc",
Short: "generate doc project: 生成文檔項(xiàng)目",
Long: "doc命令用于生成文檔項(xiàng)目。",
Run: runDocCommand,
}
func initDocCommand() {
wd, err := os.Getwd()
if err != nil {
return
}
// 聲明命令參數(shù)
docCommand.Flags().String("components-dir", path.Join(wd, "projects", "components"), "指定組件目錄的絕對(duì)路徑")
docCommand.Flags().String("doc-dir", path.Join(wd, "projects", "design-doc"), "指定設(shè)計(jì)文檔目錄的絕對(duì)路徑")
docCommand.Flags().String("docs-dir", path.Join(wd, "docs"), "指定文檔目錄的絕對(duì)路徑")
docCommand.Flags().Bool("watch", true, "監(jiān)聽(tīng)文件變化")
}
func init() {
initDocCommand()
generateCommand.AddCommand(docCommand)
generateCommand.AddCommand(serviceCommand)
generateCommand.AddCommand(staticIconsCommand)
rootCommand.AddCommand(generateCommand)
}在上述代碼中,我們對(duì)命令和參數(shù)進(jìn)行了更具描述性的命名,以便開(kāi)發(fā)者更容易理解其功能。同時(shí),我們還添加了關(guān)于工具的簡(jiǎn)短和長(zhǎng)描述,以提供更多上下文信息。這將有助于用戶(hù)更好地理解如何使用這個(gè)命令行工具以及它的目標(biāo)。
這樣我們就可以運(yùn)行類(lèi)似如下命令了:
nx g doc --components-dir xxxx
任務(wù)流管理
在這個(gè)工具中我們可以拆分很多子任務(wù),有的任務(wù)需要依賴(lài)其他任務(wù)的完成,有的任務(wù)沒(méi)有執(zhí)行順序可以并行運(yùn)行,所以需要一個(gè)很好的任務(wù)流管理工具來(lái)幫助我們來(lái)管理這些子任務(wù)
主要代碼如下:
type Task struct {
Name string // 任務(wù)名稱(chēng)
Work func() error // 任務(wù)執(zhí)行的函數(shù)
Dependencies []*Task // 依賴(lài)的任務(wù)
mu sync.Mutex // 互斥鎖,用于同步
cond *sync.Cond // 條件變量,用于等待任務(wù)完成
done bool // 任務(wù)完成標(biāo)志
StartTime time.Time // 任務(wù)開(kāi)始時(shí)間
EndTime time.Time // 任務(wù)結(jié)束時(shí)間
noOutputLog bool // 是否輸出日志
}
// printExecutionTime 輸出任務(wù)執(zhí)行時(shí)間
func printExecutionTime(task *Task) {
executionTime := task.EndTime.Sub(task.StartTime).Milliseconds()
color.Green.Println(fmt.Sprintf("[%s] 任務(wù)完成 執(zhí)行時(shí)間:%d 毫秒", task.Name, executionTime))
}
// NewTask 創(chuàng)建一個(gè)新任務(wù)
func NewTask(name string, work func() error) *Task {
task := &Task{
Name: name,
Work: work,
done: false,
}
task.cond = sync.NewCond(&task.mu)
return task
}
// SetDependency 設(shè)置任務(wù)的依賴(lài)關(guān)系
func (t *Task) SetDependency(dependencies ...*Task) {
t.Dependencies = append(t.Dependencies, dependencies...)
}
// WaitForDependencies 等待任務(wù)的依賴(lài)任務(wù)完成
func (t *Task) WaitForDependencies() {
for _, dep := range t.Dependencies {
dep.WaitForCompletion()
}
}
// Run 運(yùn)行任務(wù)
func (t *Task) Run() error {
t.WaitForDependencies()
t.mu.Lock()
defer t.mu.Unlock()
t.StartTime = time.Now()
if !t.noOutputLog {
color.Green.Println(fmt.Sprintf("[%s] 任務(wù)開(kāi)始", t.Name))
}
err := t.Work()
if err != nil {
return err
}
t.EndTime = time.Now()
t.done = true
if !t.noOutputLog {
printExecutionTime(t)
}
t.cond.Broadcast()
return nil
}
// WaitForCompletion 等待任務(wù)完成
func (t *Task) WaitForCompletion() {
t.mu.Lock()
defer t.mu.Unlock()
for !t.done {
t.cond.Wait()
}
}
// SerialTask 串行執(zhí)行任務(wù)
func SerialTask(tasks []*Task) {
for _, task := range tasks {
task.Run()
}
}
// ParallelTask 并行執(zhí)行任務(wù)
func ParallelTask(tasks []*Task) {
var wg sync.WaitGroup
for _, task := range tasks {
wg.Add(1)
go func(t *Task) {
defer wg.Done()
t.Run()
}(task)
}
wg.Wait()
}通過(guò)上述簡(jiǎn)單封裝,我們可以這樣使用輕松管理子任務(wù)的執(zhí)行
var clearCacheTask = flows.NewTask("清除項(xiàng)目緩存", func() error {
return nil
})
var copyProjectTask = flows.NewTask("復(fù)制項(xiàng)目模板", func() error {
return nil
})
// 設(shè)置依賴(lài) copyProjectTask 依賴(lài) clearCacheTask任務(wù)
copyProjectTask.SetDependency(clearCacheTask)
var collectTemplateMetaTask = flows.NewTask("收集模板信息", func() error {
return nil
})
flows.ParallelTask([]*flows.Task{
clearCacheTask,
copyProjectTask,
collectTemplateMetaTask,
})
上述示例中clearCacheTask, copyProjectTask, collectTemplateMetaTask 這三個(gè)任務(wù)會(huì)并行運(yùn)行,不過(guò)copyProjectTask依賴(lài)了clearCacheTask,需要等clearCacheTask執(zhí)行完成才會(huì)真正執(zhí)行。
Markdown文檔解析
在組件庫(kù)文檔中,Markdown(md)文檔通常占據(jù)著相當(dāng)大的比例。這些文檔不僅包括了示例代碼,還包括了組件庫(kù)的介紹、使用指南、組件API等內(nèi)容。為了處理這些Markdown文檔,我們使用了 github.com/yuin/goldmark 這個(gè)工具庫(kù)。本節(jié)將詳細(xì)介紹如何使用它來(lái)將Markdown文檔轉(zhuǎn)換為HTML格式。
核心代碼如下;
func convertToHTML(markdownContent string) string {
var htmlOutput bytes.Buffer
md := goldmark.New(
goldmark.WithExtensions(extension.GFM), // 支持GitHub風(fēng)格的Markdown
// 如果需要語(yǔ)法高亮,可以啟用以下代碼(需要配置chroma等選項(xiàng))
//goldmark.WithExtensions(
// highlighting.NewHighlighting(
// highlighting.WithStyle("github"),
// highlighting.WithFormatOptions(
// chromahtml.WithClasses(true),
// ),
// ),
//),
goldmark.WithRenderer(HtmlRenderer()), // 使用自定義的HTML渲染器
goldmark.WithRendererOptions(html.WithUnsafe()), // 允許HTML渲染器輸出不安全的HTML
)
if err := md.Convert([]byte(markdownContent), &htmlOutput); err != nil {
panic(err)
}
return htmlOutput.String()
}需要注意的是, 我們啟用了 html.WithUnsafe() 選項(xiàng), 如果不開(kāi)啟的話,默認(rèn)情況下,goldmark 不會(huì)呈現(xiàn)原始 HTML 或潛在危險(xiǎn)的鏈接
這段核心代碼演示了如何使用github.com/yuin/goldmark庫(kù)將Markdown文檔內(nèi)容轉(zhuǎn)換為HTML格式。它首先創(chuàng)建了一個(gè)goldmark實(shí)例,配置了一些擴(kuò)展(例如支持GitHub風(fēng)格的Markdown和語(yǔ)法高亮),然后將Markdown內(nèi)容傳遞給md.Convert函數(shù),最終將轉(zhuǎn)換后的HTML輸出到htmlOutput緩沖區(qū)中。
如果需要語(yǔ)法高亮,可以根據(jù)需要取消注釋相關(guān)部分,并進(jìn)行相應(yīng)的配置。
Markdown文檔解析是生成組件庫(kù)文檔的重要一步,它使我們能夠?qū)arkdown格式的文檔轉(zhuǎn)換為易于閱讀和導(dǎo)航的HTML格式,為用戶(hù)提供了更好的文檔瀏覽體驗(yàn)。
這段代碼中使用了自定義HTML渲染器,自定義渲染器主要對(duì)md標(biāo)簽進(jìn)行了特殊定制,轉(zhuǎn)換HTML時(shí),h標(biāo)簽上需要攜帶ID,方便后續(xù)的文檔錨點(diǎn)進(jìn)行錨點(diǎn)導(dǎo)航。
核心代碼如下:
// CustomHTMLRenderer 自定義渲染器
type CustomHTMLRenderer struct {
html.Renderer
}
func HtmlRenderer() renderer.Renderer {
return renderer.NewRenderer(renderer.WithNodeRenderers(util.Prioritized(NewRenderer(), 1000)))
}
func NewRenderer(opts ...html.Option) renderer.NodeRenderer {
r := &CustomHTMLRenderer{
Renderer: html.Renderer{
Config: html.NewConfig(),
},
}
for _, opt := range opts {
opt.SetHTMLOption(&r.Config)
}
return r
}
// renderHeading 自定義標(biāo)簽渲染
func (r *CustomHTMLRenderer) renderHeading(
w util.BufWriter, source []byte, node ast.Node, entering bool) (ast.WalkStatus, error) {
n := node.(*ast.Heading)
if entering {
lines := n.BaseBlock.Lines()
if lines.Len() > 0 {
at := n.BaseBlock.Lines().At(0)
buf := at.Value(source)
// 附加id
n.SetAttribute([]byte("id"), buf)
}
_, _ = w.WriteString("<h")
_ = w.WriteByte("0123456"[n.Level])
if n.Attributes() != nil {
html.RenderAttributes(w, node, html.HeadingAttributeFilter)
}
_ = w.WriteByte('>')
} else {
_, _ = w.WriteString("</h")
_ = w.WriteByte("0123456"[n.Level])
_, _ = w.WriteString(">\n")
}
return ast.WalkContinue, nil
}
func (r *CustomHTMLRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer) {
r.Renderer.RegisterFuncs(reg)
// 注冊(cè) 覆蓋內(nèi)置的標(biāo)題渲染邏輯
reg.Register(ast.KindHeading, r.renderHeading)
}
文檔元數(shù)據(jù)收集
在將Markdown文檔渲染為HTML并呈現(xiàn)在頁(yè)面上時(shí),我們需要了解渲染的位置、順序、語(yǔ)言、標(biāo)題等重要信息。為了實(shí)現(xiàn)這一目標(biāo),通常在Markdown文檔的開(kāi)頭聲明這些信息。例如:

因此,我們需要收集并匯總這些元數(shù)據(jù),以供后續(xù)文檔生成使用。
以下是核心代碼示例,配有詳細(xì)的注釋?zhuān)?/p>
func ParseMarkdown(filePath string) (*Document, error) {
// 讀取Markdown文件內(nèi)容
mdContent, err := ioutil.ReadFile(filePath)
if err != nil {
return nil, err
}
// 使用正則表達(dá)式提取YAML元數(shù)據(jù)部分
re := regexp.MustCompile(`---\r*\n([\s\S]*?)\r*\n---`)
match := re.FindStringSubmatch(string(mdContent))
if len(match) < 2 {
return nil, fmt.Errorf("YAML section not found")
}
// 獲取YAML元數(shù)據(jù)內(nèi)容
yamlContent := match[1]
// 獲取除去YAML元數(shù)據(jù)的Markdown內(nèi)容
markdownContent := string(mdContent)[len(yamlContent)+8:]
// 解析YAML元數(shù)據(jù)
var metadata Metadata
if err := yaml.Unmarshal([]byte(yamlContent), &metadata); err != nil {
return nil, fmt.Errorf("error parsing YAML: %w", err)
}
// 獲取文件名(包括擴(kuò)展名)
fileNameWithExtension := filepath.Base(filePath)
// 去除擴(kuò)展名,獲得文件名
fileName := strings.TrimSuffix(fileNameWithExtension, filepath.Ext(fileNameWithExtension))
// 創(chuàng)建文檔對(duì)象,包括元數(shù)據(jù)和多語(yǔ)言HTML內(nèi)容
document := Document{
Metadata: metadata,
ZhCN: convertToHTML(getSectionContent(markdownContent, "zh-CN")),
EnUS: convertToHTML(getSectionContent(markdownContent, "en-US")),
FileKey: fileName,
}
return &document, nil
}這段核心代碼演示了如何從Markdown文檔中提取YAML格式的元數(shù)據(jù)部分,并將其解析為元數(shù)據(jù)對(duì)象。隨后,代碼將Markdown文檔內(nèi)容分成不同語(yǔ)言的部分,并將其轉(zhuǎn)換為HTML格式。
文檔元數(shù)據(jù)收集是文檔生成過(guò)程中的關(guān)鍵步驟,它允許我們獲取文檔的關(guān)鍵信息,如標(biāo)題、語(yǔ)言等,以便更好地呈現(xiàn)文檔內(nèi)容。這些信息將對(duì)后續(xù)文檔生成和導(dǎo)航起到至關(guān)重要的作用。
文檔錨點(diǎn)
文檔錨點(diǎn)是一種重要的導(dǎo)航工具,它們可以幫助用戶(hù)快速跳轉(zhuǎn)到文檔中的特定部分。在組件庫(kù)文檔中,文檔錨點(diǎn)特別有用,因?yàn)樗鼈兪褂脩?hù)能夠快速找到他們需要的信息,提高了文檔的可讀性和可用性。
核心代碼如下:
func wrapperAnchor(content string, anchor string) string {
return fmt.Sprintf(
"<div class="doc-content">\n\t\t%s\n</div><nx-anchor container="#component-demo">%s</nx-anchor>", content, anchor)
}
// ...
templateString += wrapperAnchor(angularNonBindAble(templateContent), strings.Join(anchorLink, "\n"))
anchorLink 是從前面收集的元數(shù)據(jù)解析而來(lái)
文檔生成
文檔生成是組件庫(kù)文檔工具的核心部分,它負(fù)責(zé)將收集到的元數(shù)據(jù)、Markdown文檔解析結(jié)果和文檔錨點(diǎn)整合在一起,最終生成用戶(hù)友好的組件庫(kù)文檔。在這一章節(jié)中,我們將討論如何使用Go語(yǔ)言來(lái)實(shí)現(xiàn)文檔生成的關(guān)鍵功能。首先,讓我們來(lái)了解文檔生成的一般流程。
文檔生成通常包括以下主要步驟:
- 收集元數(shù)據(jù): 獲取組件庫(kù)中的各個(gè)文檔的元數(shù)據(jù),包括標(biāo)題、語(yǔ)言、作者等信息。
- Markdown文檔解析: 將Markdown文檔解析為HTML格式,以便用戶(hù)可以在頁(yè)面上瀏覽和交互。
- 創(chuàng)建文檔錨點(diǎn): 在文檔中創(chuàng)建錨點(diǎn),以便用戶(hù)可以輕松導(dǎo)航和快速跳轉(zhuǎn)到感興趣的部分。
- 整合內(nèi)容: 將元數(shù)據(jù)、Markdown解析結(jié)果和錨點(diǎn)整合在一起,構(gòu)建完整的組件庫(kù)文檔。
- 生成HTML頁(yè)面: 最終,將整合后的文檔轉(zhuǎn)換為HTML頁(yè)面,并提供用戶(hù)友好的界面。
核心代碼如下:
// registrationTask 注冊(cè)相關(guān)子任務(wù)&處理任務(wù)之間的依賴(lài)關(guān)系
func (receiver *CompileDocTask) registrationTask() {
// 創(chuàng)建清除 design-doc 任務(wù)
receiver.ClearDesignDocTask = flows.NewTask("清除 design-doc", receiver.clearTaskHandler)
// 創(chuàng)建復(fù)制 design-doc 任務(wù)
receiver.CopyDesignDocTask = flows.NewTask("復(fù)制 design-doc", receiver.copyDocProjectTaskHandler)
// 設(shè)置復(fù)制任務(wù)依賴(lài)于清除任務(wù)
receiver.CopyDesignDocTask.SetDependency(receiver.ClearDesignDocTask)
// 創(chuàng)建收集全局文檔信息任務(wù)
receiver.CollectGlobalDocsTask = flows.NewTask("收集全局文檔信息", receiver.collectGlobalDocsTaskHandler)
// 創(chuàng)建收集組件文檔信息任務(wù)
receiver.CollectComponentDocsTask = flows.NewTask("收集組件文檔信息", receiver.collectComponentDocsTaskHandler)
// 創(chuàng)建生成全局文檔任務(wù)
receiver.GenerateGlobalDocsTask = flows.NewTask("生成全局文檔", receiver.generateGlobalDocsTaskHandler)
// 設(shè)置生成全局文檔任務(wù)依賴(lài)于復(fù)制和收集任務(wù)
receiver.GenerateGlobalDocsTask.SetDependency(
receiver.CopyDesignDocTask,
receiver.CollectGlobalDocsTask,
)
// 創(chuàng)建生成demo文檔任務(wù)
receiver.GenerateDemoDocsTask = flows.NewTask("生成demo文檔", receiver.generateDemoDocsTaskHandler)
// 設(shè)置生成demo文檔任務(wù)依賴(lài)于收集組件文檔信息任務(wù)
receiver.GenerateDemoDocsTask.SetDependency(receiver.CollectComponentDocsTask)
}
// CompileTask 編譯文檔 處理元數(shù)據(jù)收集,md文檔解析等
func (receiver *CompileDocTask) CompileTask() {
// 并行執(zhí)行清除、復(fù)制、收集任務(wù)
flows.ParallelTask([]*flows.Task{
receiver.ClearDesignDocTask,
receiver.CopyDesignDocTask,
receiver.CollectComponentDocsTask,
receiver.CollectGlobalDocsTask,
})
}
// GenerateTask 將收集的信息整合到一起生成完整的組件庫(kù)文檔
func (receiver *CompileDocTask) GenerateTask() {
// 并行執(zhí)行生成全局文檔和生成demo文檔任務(wù)
flows.ParallelTask([]*flows.Task{
receiver.GenerateGlobalDocsTask,
receiver.GenerateDemoDocsTask,
})
}
func runDocCommand(cmd *cobra.Command, _ []string) {
componentsDir, _ := cmd.Flags().GetString("components-dir")
docDir, _ := cmd.Flags().GetString("doc-dir")
docsDir, _ := cmd.Flags().GetString("docs-dir")
watch, _ := cmd.Flags().GetBool("watch")
sourceDir := path.Join("design-doc") // 源目錄
// 創(chuàng)建文檔生成任務(wù)
compileDocTask := NewCompileDocTask(componentsDir, docDir, docsDir, sourceDir)
// 執(zhí)行編譯任務(wù)
compileDocTask.CompileTask()
// 執(zhí)行生成任務(wù)
compileDocTask.GenerateTask()
if watch {
// 監(jiān)聽(tīng)單個(gè)文件的變化 實(shí)現(xiàn)局部更新
watchDoc(cmd, compileDocTask)
}
}在這個(gè)示例中,我們首先創(chuàng)建了文檔生成任務(wù)并注冊(cè)了相關(guān)的子任務(wù)以及它們之間的依賴(lài)關(guān)系。然后,我們展示了如何執(zhí)行編譯任務(wù)和生成任務(wù)
生成結(jié)果如下:

使用效果
生成速度
整體下來(lái)300ms不到就生成了完整的組件庫(kù)文檔了

局部更新
可以看到修改group.ts文件觸發(fā)更新所需時(shí)間也是非??斓?/p>

總結(jié)
本文介紹了一款強(qiáng)大的組件庫(kù)文檔生成工具,使用Go語(yǔ)言作為開(kāi)發(fā)語(yǔ)言。該工具旨在提高組件庫(kù)文檔的可用性和可維護(hù)性,同時(shí)也力求提供毫秒級(jí)的文檔生成體驗(yàn)。通過(guò)本文,我們深入探討了工具的各個(gè)方面,包括命令行工具、任務(wù)流管理、Markdown文檔解析、文檔元數(shù)據(jù)收集、文檔錨點(diǎn)以及文檔生成等關(guān)鍵特性。
源碼鏈接
你可以在以下鏈接找到完整的源代碼和工具的實(shí)現(xiàn)細(xì)節(jié):
關(guān)鍵功能和步驟
- 命令行工具: 我們使用Go語(yǔ)言的
github.com/spf13/cobra庫(kù)創(chuàng)建了一個(gè)命令行工具,使工具能夠以包裝的方式輕松使用。 - 任務(wù)流管理: 我們實(shí)現(xiàn)了任務(wù)流管理,支持并行和串行任務(wù),以有效管理異步任務(wù)的執(zhí)行順序。
- Markdown文檔解析: 使用
github.com/yuin/goldmark庫(kù),我們能夠?qū)arkdown文檔轉(zhuǎn)換為HTML,以便用戶(hù)可以在頁(yè)面上瀏覽和交互。 - 文檔元數(shù)據(jù)收集: 工具可以從Markdown文檔中收集元數(shù)據(jù),包括標(biāo)題、語(yǔ)言、作者等信息,以供后續(xù)文檔生成使用。
- 文檔錨點(diǎn): 我們討論了如何在Markdown文檔中創(chuàng)建文檔錨點(diǎn),以幫助用戶(hù)快速導(dǎo)航到感興趣的部分。
- 文檔生成: 最后,我們介紹了文檔生成的流程,包括任務(wù)的注冊(cè)、依賴(lài)管理和并行執(zhí)行,以將元數(shù)據(jù)、Markdown解析結(jié)果和錨點(diǎn)整合為用戶(hù)友好的組件庫(kù)文檔。
這個(gè)組件庫(kù)文檔生成工具可以大大簡(jiǎn)化文檔編寫(xiě)和維護(hù)的工作,并提供出色的文檔瀏覽體驗(yàn)。通過(guò)深入了解本文所述的關(guān)鍵特性和源代碼,您可以定制并集成這個(gè)工具到您的項(xiàng)目中,提升組件庫(kù)文檔的質(zhì)量和效率。
以上就是使用Go語(yǔ)言編寫(xiě)一個(gè)毫秒級(jí)生成組件庫(kù)文檔工具的詳細(xì)內(nèi)容,更多關(guān)于Go組件庫(kù)文檔工具的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章!
相關(guān)文章
Golang開(kāi)發(fā)庫(kù)的集合及作用說(shuō)明
這篇文章主要為大家介紹了Golang開(kāi)發(fā)golang庫(kù)的集合及簡(jiǎn)單的作用說(shuō)明,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步2021-11-11
Go通過(guò)SJSON實(shí)現(xiàn)動(dòng)態(tài)修改JSON
在Go語(yǔ)言 json 處理領(lǐng)域,在 json 數(shù)據(jù)處理中,讀取與修改是兩個(gè)核心需求,本文我們就來(lái)看看如何使用SJSON進(jìn)行動(dòng)態(tài)修改JSON吧,有需要的小伙伴可以了解下2025-03-03
golang使用sync.singleflight解決熱點(diǎn)緩存穿透問(wèn)題
在go的sync包中,有一個(gè)singleflight包,里面有一個(gè)?singleflight.go文件,代碼加注釋?zhuān)还?00行出頭,通過(guò)?singleflight可以很容易實(shí)現(xiàn)緩存和去重的效果,避免重復(fù)計(jì)算,接下來(lái)我們就給大家詳細(xì)介紹一下sync.singleflight如何解決熱點(diǎn)緩存穿透問(wèn)題2023-07-07
Go語(yǔ)言學(xué)習(xí)之運(yùn)算符使用詳解
這篇文章主要介紹了Go語(yǔ)言中常用運(yùn)算符的使用,本文給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2022-04-04
詳解Gotorch多機(jī)定時(shí)任務(wù)管理系統(tǒng)
遵循著“學(xué)一門(mén)語(yǔ)言最好的方式是使用它”的理念,想著用Go來(lái)實(shí)現(xiàn)些什么,剛好有一個(gè)比較讓我煩惱的問(wèn)題,于是用Go解決一下,即使不在生產(chǎn)環(huán)境使用,也可以作為Go語(yǔ)言學(xué)習(xí)的一種方式。2021-05-05

