Database columns, functions, triggers and procedures should be commented

Database columns, functions, triggers and procedures should be commented

Software AgilityEmbedded Documentation
This code insight counts the number of function parameters, triggers, procedures and database columns (on CREATE TABLE) that are not commented. Based on specific thresholds CAST has defined, Highlight counts penalty points to the scanned file.

Why you should care

Making sure your code artifacts are well documented is key to allowing development teams to maintain applications faster and more confidently. This is particularly true for this code insight that concerns database-related artifacts such as stored procedures, functions, triggers and more generally source code that can impact data.


CAST recommendations

Code artifacts should be documented as often as you can to ensure that a developer who doesn’t know the application can quickly understand what the code is doing, in order to modify it (bug fix or functional evolutions) while decreasing the risk of introducing new bugs.

About CAST and Highlight’s Code Insights

Over the last 25 years, CAST has leveraged unique knowledge on software quality measurement by analyzing thousands of applications and billions of lines of code. Based on this experience and community standards on programming best practices, Highlight implements hundreds of code insights across 15+ technologies to calculate health factors of a software.

How it worksFeatures & Analytics