zoukankan      html  css  js  c++  java
  • godoc使用方法介绍

    一、go doc简介

    Godoc是go语言的文档化工具,类似于文档化工具godoc,类似于Python的Docstring和Java的Javadoc
    Godoc通过解析包含注释的Go代码来生成HTML或文本类型的文档。

    二、约定规则

    godoc
    Go的注释规则很简单,为类型,变量,常量,函数或包编写注释时,直接在这些声明前编写普通形式的注释,中间不留空行即可。Godoc将这些注释与后面的声明连接到一起,达到文档化的目的。

    1.注释符// 后加空格
    // 这是一行注释
    package main
    
    2.注释紧邻关键字行写,否则不会被识别
    // 不会被识别
    
    // 会被识别
    package main
    
    // 不会被识别
    
    // 会被识别1
    // 会被识别2
    func main(){
    
    }
    
    3.注释行的数量最好不要超过3行
    4.已知bug注释:BUG(who)

    godoc的输出将忽略那些与顶层声明不相邻的注释,只有一个例外,那就是以BUG(who)开头的注释。这些注释将被识别为已知的bug,并包含在文档的BUGS区。

    // 注释
    package main
    
    
    // BUG(who)  //会被识别,放入文档的Bugs区
    
    
    const a = 8
    

    三、使用命令

    首先在命令行进入所需要执行的.go文档目录
    例:我的test.go放在C:/GoProject/src/test/ 目录下
    需要在命令行进入C:/GoProject/src/test/
    然后执行命令

     godoc -http=:6060     //6060是godoc提供的默认端口
    

    在浏览器输入 localhost:6060
    ,即可进入godoc的网站,查看自己的文档需要在地址栏输入路径 localhost:6060/pkg/test

  • 相关阅读:
    zookeeper java调用及权限控制
    走进C++程序世界------IO标准库介绍
    Unity3d 镜面折射 vertex and frag Shader源代码
    servlet上传文件报错(二)
    模仿linux内核定时器代码,用python语言实现定时器
    6.12交流
    python学习(三) 使用字符串
    JAVA面试(四)
    python学习(二) 列表和元组
    C++面试题(三)
  • 原文地址:https://www.cnblogs.com/niuben/p/12387357.html
Copyright © 2011-2022 走看看