hbase-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Appy (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (HBASE-14902) Revert some of the stringency recently introduced by checkstyle tightening
Date Wed, 02 Dec 2015 01:09:10 GMT

    [ https://issues.apache.org/jira/browse/HBASE-14902?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15035036#comment-15035036
] 

Appy commented on HBASE-14902:
------------------------------

Here are the reasons why I think it'd be good to have them. Would be easy to turn off if people
feel otherwise
JavadocTagContinuationIndentationCheck : Javadoc tool certainly doesn't care about it since
it simply wraps the text in the browser based on width. However, we almost always see the
comments in IDEs, and there are easily 5+ different ways I have seen them formatted. Having
formatted comments isn't anything worth much worry, but wouldn't hurt if there are 2-3 simple
rules which makes commenting more consistent.

NonEmptyAtclauseDescriptionCheck: Ref guide has this guideline [here|http://hbase.apache.org/book.html#common.patch.feedback.javadoc.defaults]
. I also feel like we should have this. "@throws SomeException" before functions isn't really
of any use unless it explains why and when the exception is thrown. Same for arguments and
return types. These are always auto-generated, and having checks around these tags will make
devs think about them and write better comments (or at the very least, get rid of useless
lines).

NeedBracesCheck: Anything is fine. [Here's|http://checkstyle.sourceforge.net/config_blocks.html#NeedBraces]
how to allow single line statements 

> Revert some of the stringency recently introduced by checkstyle tightening
> --------------------------------------------------------------------------
>
>                 Key: HBASE-14902
>                 URL: https://issues.apache.org/jira/browse/HBASE-14902
>             Project: HBase
>          Issue Type: Sub-task
>            Reporter: stack
>             Fix For: 2.0.0
>
>
> I think we should undo some of the plugins that were recently added to checkstyle. They
are too much.
> JavadocTagContinuationIndentationCheck is about adding indent if javadoc is two lines
or more (javadoc tool doesn't care)
> NonEmptyAtclauseDescriptionCheck would have us add javadoc on each exception: e.g. @throws
IOException needs to have text added.
> NeedBracesCheck has us undoing cases where an if fits all on one line (don't want to
start style wars but if short and fits on one line, I think its more readable... but I could
relent on this one.... ).
> The first two at least should go.
> You ok w/ that [~appy]



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Mime
View raw message