jednano / eclint

Validate or fix code that doesn't adhere to EditorConfig settings or infer settings from existing code.
MIT License
305 stars 28 forks source link

Better formatting for JavaDocs #149

Closed mcandre closed 6 years ago

mcandre commented 6 years ago

By convention, Java API documentation comments don't follow the simple indentation nesting rules, but rather line up each line with the opening indentation + an additional space + an asterisk + a further space + some comment text (optional):

/**
 * Blah
 * Blah
 * Blah
 */
public class ThingAMaBob {}

Could we inform eclint to handle *.java sources better, so that EditorConfig rules for indentation don't clash with JavaDoc conventions?

As a workaround, I can set the indentation to a single space, but that's not really good.

jednano commented 6 years ago

Duplicate of #85 and #39.

gucong3000 commented 6 years ago
# EditorConfig is awesome: http://EditorConfig.org

# top-most EditorConfig file
root = true

[*]
block_comment_start = /*
block_comment = *
block_comment_end = */