Skip to Content (Press Enter)
Back to Ideas
22
Like
Follow Idea
White list Names for architecture dashboard rule "Missing description on public element"
533Views
7Comments
New
Architecture & Governance 

It would be nice if we could maintain in the Architecture configuration a "whitelist" of self-explanatory names that don't need a description.

This list could have default already have the most common names like:

  • *Id
  • Name
  • Label
  • Description
  • CreatedBy
  • UpdatedBy
  • CreatedOn
  • UpdatedOn

The code analysis pattern Missing description on public element", should then use this list and exclude reporting elements with names that are on this list.


 

14 Feb 2021
Copy link to comment

I don't mind Architecture Dashboard, but this particular finding just needs to be removed. There are exceedingly few items where the names do not make the functionality obvious.

J.Ja

15 Feb 2021
Copy link to comment

I prefer not to add an explanation of the name but the purpose of the element that I describe.  The purpose why the element exists is not always clear from its name and does add to the maintainaaintainabillity and readabillity of the code especially if you have to onboard new developers to the team.

But I agree for many elements it's not needed, and for that I would like to whitelist names.

15 Feb 2021
Copy link to comment

Great idea.

18 Feb 2021
Copy link to comment

Good idea! 

18 Feb 2021
Copy link to comment

Self-explanatory names are better than descriptions. But it's difficult to identify when the name is good enough to understand the concept.

03 Mar 2021
Copy link to comment

Great idea! 




13 Apr 2021
Copy link to comment

I would support whitelisting.  But I'd also like this moved from architecture dashboard to service studio - it should not be hard to surface a warning and keep it clean from the start.

23 Nov 2021
Copy link to comment