Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Style: Commenting style #592

Open
Tille88 opened this issue Apr 8, 2018 · 1 comment
Open

Style: Commenting style #592

Tille88 opened this issue Apr 8, 2018 · 1 comment

Comments

@Tille88
Copy link
Member

Tille88 commented Apr 8, 2018

For the style guide, it would be nice to see or point developers to what is considered a good or bad comments?

The codebase is not very comment heavy, but some examples of when a variable/function name is declarative enough that adding comments could do more harm than good could be useful when trying to add to the codebase without having to just sample a small part of the code and then hope it is representative.

@Tille88
Copy link
Member Author

Tille88 commented Apr 8, 2018

Alternatively having a documentaiton tool taking away the need for quite a few comments, such as return values information? JSdocs doesn't seem to be heavily used for angular, this one seems to be the most used one https://compodoc.github.io/compodoc/

Still would probably not remove all the need for commenting guidance given the amount of people who are likely to move in and out of this project over time.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant