Principles Wiki

User Tools

Site Tools

You are here: Principles Wiki » principles » Rule of Explicitness (RoE)
principles:rule_of_explicitness

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
principles:rule_of_explicitness [2021-09-02 12:38] – old revision restored (2021-05-19 11:23) 65.21.179.175principles:rule_of_explicitness [2021-10-18 22:06] (current) – +++ restored +++ christian
Line 9: Line 9:
   * [[contexts:Object-Oriented Design]]   * [[contexts:Object-Oriented Design]]
   * [[contexts:API Design]]   * [[contexts:API Design]]
 +  * [[contexts:Implementation]]
  
 ===== Principle Statement ===== ===== Principle Statement =====
Line 34: Line 34:
     * Avoid highly configurable modules. Instead implement varying behavior explicitly.     * Avoid highly configurable modules. Instead implement varying behavior explicitly.
   * Explicitly state which module to use   * Explicitly state which module to use
-    * Avoid importing all classes of a given package/namespace and import the needed classes explicitly. In Java this means not to specify wildcard imports like ''import package.*'' and to avoid static imports. Similarly in Python this means not to use wildcard imports.+    * Avoid importing all classes of a given package/namespace and import the needed classes explicitly. In Java this means not to specify wildcard imports like ''import package.*'' and to avoid static imports. Similarly in Python this means not to use wildcard imports. In C++, do not import entire namespaces (e.g. do not use ''using namespace std;'').
     * Avoid ''with'' statements in Delphi and other languages having constructs that let you invoke methods without explicitly stating the associated object.     * Avoid ''with'' statements in Delphi and other languages having constructs that let you invoke methods without explicitly stating the associated object.
   * Explicitly name parameters   * Explicitly name parameters
Line 84: Line 84:
   * [[Generalization Principle]] (GP): RoE often results in specific solutions. Generality often requires stating something implicitly.   * [[Generalization Principle]] (GP): RoE often results in specific solutions. Generality often requires stating something implicitly.
   * [[Low Coupling]] (LC): Direct communication typically has the disadvantage of a higher coupling. Indirection reduces coupling but creates implicit/indirect communication paths.    * [[Low Coupling]] (LC): Direct communication typically has the disadvantage of a higher coupling. Indirection reduces coupling but creates implicit/indirect communication paths. 
- +  * [[Don't Repeat Yourself]] (DRY): Following RoE sometimes leads to duplication.
 ==== Complementary Principles ==== ==== Complementary Principles ====
  
   * [[Keep It Simple Stupid]] (KISS): Explicit solutions are often also simpler.   * [[Keep It Simple Stupid]] (KISS): Explicit solutions are often also simpler.
-  * [[Murphy's Law]] (ML):The typical reason for RoE is to avoid unnecessarily complicated solutions and possibilities for defects. Don't loose that goal out of sight.+  * [[Murphy's Law]] (ML):The typical reason for RoE is to avoid unnecessarily complicated solutions and possibilities for defects. Don't lose sight of that goal.
   * [[Model Principle]] (MP): RoE states that [[anti-patterns:primitive obsession]] shall be avoided. Instead more specific types should be used in parameter lists. MP makes this even clearer: In object-orientation objects instead of plain integers or strings are used.   * [[Model Principle]] (MP): RoE states that [[anti-patterns:primitive obsession]] shall be avoided. Instead more specific types should be used in parameter lists. MP makes this even clearer: In object-orientation objects instead of plain integers or strings are used.
 +  * [[Law of Leaky Abstractions]] (LLA): Often abstractions create a level of implicitness. Abstraction leaks are one reason why explicit solutions can be considered preferable.
  
 ==== Principle Collections ==== ==== Principle Collections ====
Line 112: Line 111:
   * Martin Fowler: //[[http://martinfowler.com/ieeeSoftware/explicit.pdf|To Be Explicit]]//   * Martin Fowler: //[[http://martinfowler.com/ieeeSoftware/explicit.pdf|To Be Explicit]]//
   * Tim Peters: //[[http://www.python.org/dev/peps/pep-0020/|The Zen of Python]]//   * Tim Peters: //[[http://www.python.org/dev/peps/pep-0020/|The Zen of Python]]//
 +
 +===== Discussion =====
 +
 +Discuss this wiki article and the principle on the corresponding [[talk:principles:Rule of Explicitness|talk page]].
  
principles/rule_of_explicitness.1630579111.txt.gz · Last modified: by 65.21.179.175