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

Avoid to display the default class comment template #1

Open
Ducasse opened this issue Jun 20, 2021 · 3 comments
Open

Avoid to display the default class comment template #1

Ducasse opened this issue Jun 20, 2021 · 3 comments

Comments

@Ducasse
Copy link
Contributor

Ducasse commented Jun 20, 2021

No description provided.

@kasperosterbye
Copy link
Collaborator

The default class comment comes from ClassDescription>>classCommentBlank. That is in a core class. It does make sense to hijack it to this project, which can be done by making it an extension method of this project.

The shortest generic comment I can come up with is:

Please provide a short description of this class. It should explain how to use it (consider making examples in the class side of the class), and how to maintain and subclass it. If you have a long story to tell, consider making a microdown link to a github repository readme file.

@kasperosterbye
Copy link
Collaborator

@Ducasse - does my idea here make sense?
I might give BeautifulComments some coding-love soon.

@kasperosterbye
Copy link
Collaborator

Any ideas what you would like instead?

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

2 participants