You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@ace.apache.org by "Marcel Offermans (Commented) (JIRA)" <ji...@apache.org> on 2011/10/28 10:50:32 UTC
[jira] [Commented] (ACE-185) Checkstyle configuration for Apache
ACE
[ https://issues.apache.org/jira/browse/ACE-185?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13138174#comment-13138174 ]
Marcel Offermans commented on ACE-185:
--------------------------------------
Thanks a lot Jeremias for this contribution. Whilst I agree that it makes sense to add comments to the source code to document things like empty blocks, or more in general, to comment on any "non standard" construct you use in your code, I'm not directly in favor of changing the style guide for it. For one, style guides to me should not be set in stone and should ever prevail over common sense. Furthermore, I think that if you ask enough developers, you will get different views and preferences for a style guide, so we have to make some decisions and stick with them I guess.
> Checkstyle configuration for Apache ACE
> ---------------------------------------
>
> Key: ACE-185
> URL: https://issues.apache.org/jira/browse/ACE-185
> Project: Ace
> Issue Type: Improvement
> Reporter: Jeremias Maerki
> Priority: Minor
> Attachments: checkstyle.zip
>
>
> As promised a Checkstyle configuration file (for version 5.4). I've tried to match the ACE style guide as closely as possible. Some minor things cannot be checked. And I've had trouble mapping the empty blocks ({}) which I, BTW, don't like. I recommend to change that rule to require at least a comment. I believe it's a good idea to explain why a block is left empty. I've set the severity for WhitespaceAround to warning for now as a consequence.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira