Golang Learn to generate code documents

Source: Internet
Author: User
This is a created article in which the information may have evolved or changed.

go docThe tool extracts the first-line comments from the top-level declaration and the related comments for each object from the Go program and package files, and generates related documents.

General usage:

  • go doc packageGets the document comment for the package, for example: go doc fmt godoc fmt A document comment that uses the generated package is displayed.
  • go doc package/subpackageGets the document comment for the child package, for example: go doc container/list .
  • go doc package functionGets the document comment for a function in a package, for example: go doc fmt Printf displays fmt.Printf() instructions for use.

After you enter the command line and godoc -http=:6060 then open http://localhost:6060 with your browser, you can see the pages provided by the local document browsing server.

Related Article

Contact Us

The content source of this page is from Internet, which doesn't represent Alibaba Cloud's opinion; products and services mentioned on that page don't have any relationship with Alibaba Cloud. If the content of the page makes you feel confusing, please write us an email, we will handle the problem within 5 days after receiving your email.

If you find any instances of plagiarism from the community, please send an email to: info-contact@alibabacloud.com and provide relevant evidence. A staff member will contact you within 5 working days.

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.