We finished new version of our extension for Checkstyle - release 1.6.
I updated wiki pages to allow other developers easily join the project.
Read our publications, in Russian language, latest is for 1.5.3 release, for 1.6 will be soon.
Release 1.6.0 (21/October/2012):
LogicConditionNeedOptimizationCheck - This check prevents the placement of local variables and fields after calling methods in '&&' and '||' conditions. Done by Ilja Dubinin.
Example:
"if (isVisible() && active)" == should be refactored to ==> "if (active && isVisible())"
Reason: swap of conditions expressions will be beneficial, but some time you can find logic that in isVisible() change 'active' variable value and this optimization will not be correct - but this is sign of bad design!
ForbidCCommentsInMetods - Check prevents usage of C-style (/* ... */) comments inside method body. If you have class declaration inside method body with JavaDoc you will get error too, that is sad side effect for now, but I did not met such cases for now, so I thunk it will be incentive to move class out. Done by Ilja Dubinin.
Reason: C-style of comments are problem for future investigation, it should be treated as DEBUG/temporal comments, but should be cleared finally.
InterfaceTypeParameterNameCheck - Checks that interface type parameter(for template) names conform to a format specified by the format property. Default format is ^[A-Z]$. Done by Dmitry Gridyushko.
Reason: to avoid template types to be like <INPUT>, <CUSTOM>, <LISTENER> and force developer to name them by 1 letter <I>, <C>, <L>. to clearly indicate nature of variable in code down the file.
All details are here: http://sevntu-checkstyle.github.com/sevntu.checkstyle/
We will do bug fixing in 1.6.1 and 1.6.2 as always, please test and report bug ...... .
I updated wiki pages to allow other developers easily join the project.
Read our publications, in Russian language, latest is for 1.5.3 release, for 1.6 will be soon.
Release 1.6.0 (21/October/2012):
LogicConditionNeedOptimizationCheck - This check prevents the placement of local variables and fields after calling methods in '&&' and '||' conditions. Done by Ilja Dubinin.
Example:
"if (isVisible() && active)" == should be refactored to ==> "if (active && isVisible())"
Reason: swap of conditions expressions will be beneficial, but some time you can find logic that in isVisible() change 'active' variable value and this optimization will not be correct - but this is sign of bad design!
ForbidCCommentsInMetods - Check prevents usage of C-style (/* ... */) comments inside method body. If you have class declaration inside method body with JavaDoc you will get error too, that is sad side effect for now, but I did not met such cases for now, so I thunk it will be incentive to move class out. Done by Ilja Dubinin.
Reason: C-style of comments are problem for future investigation, it should be treated as DEBUG/temporal comments, but should be cleared finally.
InterfaceTypeParameterNameCheck - Checks that interface type parameter(for template) names conform to a format specified by the format property. Default format is ^[A-Z]$. Done by Dmitry Gridyushko.
Reason: to avoid template types to be like <INPUT>, <CUSTOM>, <LISTENER> and force developer to name them by 1 letter <I>, <C>, <L>. to clearly indicate nature of variable in code down the file.
All details are here: http://sevntu-checkstyle.github.com/sevntu.checkstyle/
We will do bug fixing in 1.6.1 and 1.6.2 as always, please test and report bug ...... .
No comments:
Post a Comment