17 lines
451 B
Markdown
17 lines
451 B
Markdown
|
# C# Comment Checker
|
||
|
|
A utility to verify the presence and style of C# method and inline comments.
|
||
|
|
|
||
|
|
## Building
|
||
|
|
```sh
|
||
|
|
./gradlew build
|
||
|
|
```
|
||
|
|
After completion the artifact will be located in build/libs
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
```sh
|
||
|
|
java -jar CSharpCommentChecker.jar path/one path/two path/three path/...
|
||
|
|
```
|
||
|
|
|
||
|
|
## Credits
|
||
|
|
Based on [CSharpCommentValidator](https://github.com/jellejurre/CSharpCommentValidator/) by [@JelleJurre](https://github.com/jellejurre/) on GitHub.
|