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

Add a check for empty comments / JavaDoc tags #87

Closed
Gama11 opened this issue Mar 1, 2016 · 1 comment
Closed

Add a check for empty comments / JavaDoc tags #87

Gama11 opened this issue Mar 1, 2016 · 1 comment
Assignees

Comments

@Gama11
Copy link
Member

Gama11 commented Mar 1, 2016

I dislike having auto-generated, empty doc comments like this:

/**
 * 
 * @param   arg
 * @param   pos
 */
@AlexHaxe
Copy link
Member

AlexHaxe commented Mar 2, 2016

This can either be done by a line based or a token tree based check, AST based checks throw away comments (mainly because there is no node in AST for comments).

I guess for this particular check a line based version would suffice.
If you want to go a step further and check if the @params match the function parameters then you would have to go token tree or have a more complex set of parsing and regex rules for a line based check.

AlexHaxe added a commit to AlexHaxe/haxe-checkstyle that referenced this issue Jun 25, 2018
adjusted autodetection for nested check
fixed reported position of EmptyBlock check
@ghost ghost assigned AlexHaxe Jun 25, 2018
@ghost ghost added the in progress label Jun 25, 2018
@ghost ghost removed the in progress label Jun 25, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants