godox

command module
v0.0.0-...-5bdcf1e Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 20, 2019 License: MIT Imports: 10 Imported by: 0

README

GoDoX

Build Status GoDoc Go Report Card GitHub issues License

GoDoX extracts comments from Go code based on keywords.

Installation

go get -u github.com/matoous/godox

Usage

Any comment lines starting with TODO or FIX (or other specified keywords, case insensitive) are extracted. If TODO/FIX comments is longer that 1 line, then only first line will be extracted.

$ godox [<flags>] [<path>...]

$ godox -h
    Usage: godox [path] [path] ...
      -h    Print help
      -keys string
            Change keywords (default "todo,bug,fix")
      -t    Include tests

$ godox ./path/to/directory ./...
example.go:3:1:TODO: Implement io.Writer interface
example.go:7:14:TODO: Rename field
example.go:15:3:FIX: Something that is broken

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
fixtures
01
This is the package comment.
This is the package comment.
02
03
TODO: Add package documentation TODO: Write an actual application
TODO: Add package documentation TODO: Write an actual application

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL