behaviorbot / update-docs

Prompts users to include documentation in pull requests
https://github.com/apps/update-docs
MIT License
32 stars 9 forks source link

Count Code Comments as Documentation #6

Open hiimbex opened 7 years ago

hiimbex commented 7 years ago

It would be cool if there were an optional param in the config file like updateDocsCodeComments that, if set to true, would scan code changes to see if any comments were added and count that as documentation.

Not sure the best approach for checking comments in different languages 🤔 but there may be resources out there that do this already.

sukrosono commented 6 years ago

i think no, some comment just like // @TODO i also found unnecessary comment.