Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/matoous/godox

GoDoX extract speficic comments from Go code based on keywords
https://github.com/matoous/godox

Last synced: about 1 month ago
JSON representation

GoDoX extract speficic comments from Go code based on keywords

Host: GitHub
URL: https://github.com/matoous/godox
Owner: matoous
License: mit
Fork: true (766b/godox)
Created: 2019-05-26T10:03:56.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2024-01-05T08:21:49.000Z (11 months ago)
Last Synced: 2024-06-18T18:39:39.452Z (6 months ago)
Language: Go
Size: 86.9 KB
Stars: 14
Watchers: 4
Forks: 3
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-ccamel - matoous/godox - GoDoX extract speficic comments from Go code based on keywords (Go)

README

        GoDoX

===

[![Tests](https://github.com/matoous/godox/actions/workflows/test.yml/badge.svg)](https://github.com/matoous/godox/actions/workflows/test.yml) 

[![Lint](https://github.com/matoous/godox/actions/workflows/lint.yml/badge.svg)](https://github.com/matoous/godox/actions/workflows/lint.yml) 

[![GoDoc](https://godoc.org/github.com/matoous/godox?status.svg)](https://godoc.org/github.com/matoous/godox)

[![Go Report Card](https://goreportcard.com/badge/github.com/matoous/godox)](https://goreportcard.com/report/github.com/matoous/godox)

[![GitHub issues](https://img.shields.io/github/issues/matoous/godox.svg)](https://github.com/matoous/godox/issues)

[![License](https://img.shields.io/badge/license-MIT%20License-blue.svg)](https://github.com/matoous/godox/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.