dimitarpetrov / godoc-generate

Default godoc generator - make your first steps towards better code documentation

godoc-generate

Overview

godoc-generate is a simple command line tool that generates default godoc comments on all exported types, functions, consts and vars in the current working directory and recursively for all subdirectories.

The godoc comments looks like this:

// %s missing godoc.

Where %s is the name of the type/func/const/var.

NOTE: The comment format can be overridden via the --format flag.

Installation

Installing from Source

go install github.com/DimitarPetrov/godoc-generate@latest

Demonstration

Let's say you have a simple Multiply function without godoc:

func Multiply(a,b int) int {
	return a * b
}

It is exported, therefore it is part of the package's interface. It is ideomatic to add godoc on everything exported in your package.

If you run godoc-genenrate the code will be rewritten the following way:

// Multiply missing godoc.
func Multiply(a, b int) int {
	return a * b
}

This way you are safe to add a linter enforcing godoc and migrate all legacy code gradually.

godoc-generate's Issues

Add support for godot

Awesome tool, it will be awesome if you can add support for https://github.com/tetafro/godot.
Basically, it will add . at the end of the comment if it's missing it.

// This is comment

after running godot fix

// This is comment.