So a metric that detects nonsense documentation ("fluff"?) is another little helper.
Here is a real world example:
/// <summary>
/// Thread Name.
/// </summary>
public string ThreadName;
/// <summary>
/// Time Stamp.
/// </summary>
public DateTime TimeStamp;
A trival example but I recon it is less readable than:
public string ThreadName;
public DateTime TimeStamp;
So the metric is: If the documentation, with white spaces removed, case insensitive matches the property, method, or type then flag as doco fluff.
1 comment:
You could set your syntax highlighting to make comments almost invisible... then you wouldn't be confused by them ;)
Nigel
Post a Comment