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

Unnecessary Documentation Asterisks Added to Non-documentation Comment Blocks #18

Open
grantjbutler opened this issue Dec 10, 2014 · 0 comments
Labels

Comments

@grantjbutler
Copy link

When writing a multi-line comment, documentation asterisks are automatically prefixed to each line of the comment. For example,

/*
 This is some information about this block of code.
 It does a thing.
 */

would become

/*
 * This is some information about this block of code.
 * It does a thing.
 */

Ideally, documentation asterisks should only be added for documentation comment blocks. That is, comment blocks that have an additional asterisk after the opening comment symbol (/**). For example,

/*
 This is some information about this block of code.
 It does a thing.
 */

would stay the same, but

/**
 This is some documentation about this method.
 @param type This is a param.
 @return This is the return type.
 */

would become

/**
 * This is some documentation about this method.
 * @param type This is a param.
 * @return This is the return type.
 */
@Twigz Twigz added the bug label Jan 5, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants