Skip to content

Latest commit

 

History

History
53 lines (44 loc) · 1.42 KB

README.md

File metadata and controls

53 lines (44 loc) · 1.42 KB

go-auto-commenter

A Go tool to add comments automatically to all the exported methods.

Build Status Coverage Status Go Report Card License

Installation

1. Clone this repo
2. cd to the cloned directory
3. Type ./install in terminal and hit enter

Uninstallation

1. Clone this repo
2. cd to the cloned directory
3. Type ./uninstall in terminal and hit enter

To auto comment all the files in current directory

autocomment .

To auto comment all the files of a directory

autocomment [DIRNAME]

To auto comment files

autocomment [FILENAME]...

Example

before ->
func AB() {

}
after ->
// AB ...
func AB(){
}

License

go-auto-commenter is released under the Apache 2.0 license. See LICENSE.txt