Missing class doc comment PHP-D1001
Documentation
Minor
2 years ago
—
2 years old
Doc comment missing for class
Tests\Support\Models\ExampleModel 4
5use CodeIgniter\Model;
6
7class ExampleModel extends Model 8{
9 protected $table = 'factories';
10 protected $primaryKey = 'id';Doc comment missing for class
Tests\Support\Database\Seeds\ExampleSeeder 4
5use CodeIgniter\Database\Seeder;
6
7class ExampleSeeder extends Seeder 8{
9 public function run()
10 {Doc comment missing for class
Tests\Support\Database\Migrations\ExampleMigration 4
5use CodeIgniter\Database\Migration;
6
7class ExampleMigration extends Migration 8{
9 protected $DBGroup = 'tests';
10Doc comment missing for class
Config\View 4
5use CodeIgniter\Config\View as BaseView;
6
7class View extends BaseView 8{
9 /**
10 * When false, the view method will clear the data between eachDoc comment missing for class
Config\Validation 7use CodeIgniter\Validation\FormatRules;
8use CodeIgniter\Validation\Rules;
9
10class Validation11{
12 //--------------------------------------------------------------------
13 // Setup
Description
Documentation comments are helpful in understanding what that part of the code is responsible for. It is always a good idea to add documentation to your code to improve the code readability and maintainability. In addition to that, it becomes helpful when you revisit the code after a long time. Here, the class is missing the doc comment and it is recommended to add it for the reasons discussed above.
If you don't want DeepSource to raise issues for missing doc comments, you can configure it in the .deepsource.toml configuration file. Please refer to the PHP docs for available options.