MDS/openide
1
0
Fork 0
mirror of https://gitflic.ru/project/openide/openide.git synced 2026-09-27 10:03:11 +07:00
Code Issues Packages Projects Releases Wiki Activity

add "new in 13" and some missing info to description

Browse Source
This commit is contained in:
Bas Leijdekkers
2013-08-19 14:38:20 +02:00
parent bdbe4421c6
commit a0b13bedd5
1 changed files with 8 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/InspectionGadgets/src/inspectionDescriptions/BooleanParameter.html
+8 -4
View File
@@ -1,10 +1,14 @@
<html>
<body>
It's almost always a mistake to add a <b>boolean</b> parameter to a public method (part of an API). When reading code using such a method
it can be difficult to decipher what the <b>boolean</b> stands for without looking at the source or documentation. This is also known as
<a href="http://ariya.ofilabs.com/2011/08/hall-of-api-shame-boolean-trap.html">the boolean trap</a>. The <b>boolean</b> parameter can often
be profitably replaced with an <b>enum</b>
It's almost always a mistake to add a <b>boolean</b> parameter to a public method (part of an API) if that method is not a setter.
When reading code using such a method, it can be difficult to decipher what the <b>boolean</b> stands for without looking at
the source or documentation.
This problem is also known as <a href="http://ariya.ofilabs.com/2011/08/hall-of-api-shame-boolean-trap.html">the boolean trap</a>.
The <b>boolean</b> parameter can often be profitably replaced with an <b>enum</b>
<!-- tooltip end -->
<p>
Use the option below to only warn when a method contains more than one boolean parameter.
<p>
<small>New in 13</small>
</body>
</html>