Attribute signature and comment are opposite

The declaration of an attribute is in contradiction with its documentation.

Example: attribute INCLUDE NAME DEFAULT whose comment documents an “exclude pattern”. Whether the pattern is included or excluded is thus unclear.

Related smells: Method signature and comment are opposite Method name and return type are opposite Attribute name and type are opposite

Reference

Venera Arnaoudova, Massimiliano Di Penta, Giuliano Antoniol. “Linguistic antipatterns: what they are and how developers perceive them". in Empirical Software Engineering (ESEM), 21(1), Feb 2016. 104-158. 10.1007/s10664-014-9350-8


Implementation Smells

Home

All rights reserved (c) Tushar Sharma 2017-23.