dnscrypt-proxy/vendor/github.com/matoous/godox/README.md

1.3 KiB

GoDoX

Tests Lint GoDoc Go Report Card GitHub issues License

GoDoX extracts comments from Go code based on keywords. This repository is fork of https://github.com/766b/godox but a lot of code has changed, this repository is updated and the code was adjusted for better integration with https://github.com/golangci/golangci-lint.

Installation

go get github.com/matoous/godox

The main idea

The main idea of godox is the keywords like TODO, FIX, OPTIMIZE is temporary and for development purpose only. You should create tasks if some TODOs cannot be fixed in the current merge request.