Godocgen Launched

On April 4, 2020 GMT+0800, ZORALab Enterprise had launched a new open-source product called Godocgen for Go Programmers. Reported directly from ZORALab Newsroom.

Reporters:
(Holloway) Chew, Kean Ho

Published:
Saturday, April 04, 2020 01:00:00 +08:00

Updated:
Thursday, April 13, 2023 16:51:10 +08:00

Available in the following languages:

The Problems

Back in 2019, Go was having trouble with its centralized documentation feature and development work was in progress. During that time, all documentations of a Go package can only be accessed via $ go doc -all .. This is annoying and a hamstrung problem for any Go developer.

After exploring some solutions especially with a product like GoHugo, website, it was decided that the package documentation solution shall be developed for the sake of solving the problem. Therefore, the Godocgen Project was initialized.

About Godocgen

The efforts are mostly parsing the Abstract Syntax Tree (AST) of a given Go Package. From there, the AST data are analyzed and processed to output a given format. The format is provided in a list of partial fragments.

At the point of release, the Project was its in its final unit-testing with 100% code coverage with the latest v0.0.2 capable of output Markdown format or HTML format.

The project's documentation is available at: OFFICIAL WEBSITE

Epilogue

That's all for this news. If you have further inquiries, please feel free to contact us at:

CONTACT US