Question
2
Replies
45
Views
Virtusa
Posted: March 10, 2017
Last activity: March 17, 2017
Closed
Solved
Usage of mentioning description and usage under documentaiton
What is the purpose of adding description and usage under documentation?
It helps to document the purpose of the rule and how it is expected to be used. Other developers can see this information when they are developing new functionality or debugging issues. If the rule is used for a long period of time, it can be helpful to have the information documented as the original developer may have moved on to another project or no longer recall the specifics related to that rule.