Missing class doc comment PHP-D1001
Documentation
Minor
10 months ago
—
2 years old
Doc comment missing for class
Tests\Unit\ExampleTest 5use Illuminate\Foundation\Testing\RefreshDatabase;
6use Tests\TestCase;
7
8class ExampleTest extends TestCase 9{
10 /**
11 * A basic test example.Doc comment missing for class
Tests\TestCase 4
5use Illuminate\Foundation\Testing\TestCase as BaseTestCase;
6
7abstract class TestCase extends BaseTestCase 8{
9 use CreatesApplication;
10}Doc comment missing for class
Tests\Feature\ExampleTest 5use Illuminate\Foundation\Testing\RefreshDatabase;
6use Tests\TestCase;
7
8class ExampleTest extends TestCase 9{
10 /**
11 * A basic test example.Doc comment missing for class
DatabaseSeeder 6use App\User;
7use Illuminate\Database\Seeder;
8
9class DatabaseSeeder extends Seeder10{
11 /**
12 * Seed the application's database.Doc comment missing for class
CreateCommentsTable 4use Illuminate\Database\Schema\Blueprint;
5use Illuminate\Support\Facades\Schema;
6
7class CreateCommentsTable extends Migration 8{
9 /**
10 * Run the migrations.
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.