issue #426 Description of the coding style #502
Conversation
Issue #426 Description of the coding style
| ## Tabs and Indents | ||
|
|
||
| * Tab size : 4 | ||
| * Indent : 4 |
There was a problem hiding this comment.
Is this hand-written, or exported from a tool?
|
Could we then get the whitespace to line up in the coding style doc? Sorry to be a stickler. |
|
Do you want to align the numbers or do I just have to remove the whitespaces? I have searched for a way to align the numbers in markdown but there isn't a simple way of doing it. |
|
I guess I don't understand the current use of whitespace--it doesn't seem to be pegged to tab stops, and it doesn't seem to be a constant number of spaces between each colon and number. If I were reading the doc in text, I think I'd either want all the numbers in a clump to start at the same column, or at least just have a single space between each colon and number. Or is there a significance to the number of spaces that Markdown is using? |
Issue #426 Removed confusing whitespaces.
|
Markdown ignores the spaces. I removed the confusing spaces you mentioned. |
|
|
||
| ## Blank Lines | ||
|
|
||
| ### Keep Maximum Blank Lines |
There was a problem hiding this comment.
What does "Keep Maximum Blank Lines" mean?
Removed the Markdown syntax, changed import order and removed confusing Maximum Blank Lines section.
|
I removed all the Markdown syntax, changed the import order (copied the wrong one) and removed the Maximum Blank Lines section. Maximum Blank Lines means for example if you have three blank lines in your method and you have set the maximum to two then the code fails the coding style. Since it's confusing I removed it. |
| * After description | ||
|
|
||
| Invalid tags | ||
| * Keep empty @param tags |
There was a problem hiding this comment.
I don't want to keep empty javadoc tags that add no information.
|
Getting close, thanks! |
- Do not align JavaDoc parameter description - Removed "Keep empty .. JavaDoc tag" - corrected typp
issue #426 Description of the coding style
|
Thanks, and sorry for the delay! |
Issue #426 Description of the coding style