VscodeでMissing file doc commentというエラーが解決できません

前提・実現したいこと

VScodeでPHP -v 7.3を使用しMySQLからデータを取得できるプログラムを作っています。

発生している問題・エラーメッセージ

Missing file doc comment

該当のソースコード

index.php

<?php
$athletes = null;
$races = null;
$ath = null;
$rac = null;
$mydb = null;

$athletes = "SELECT * FROM participating_athletes";
$ath = $mydb->query($athletes);//データ取得
$atheltes_array = $ath;
$json_athletes = json_encode($atheltes_array);

$races = "SELECT * FROM races";
$rac = $mydb->query($races);
$races_array = $rac;
$json_races = json_encode($races_array);

try {
    $mydb = new PDO('mydql:dbname=mydb;host=127.0.0.1;charset=utf=8', 'root', '');
} catch (PDOException $e) {
    echo 'DB接続エラー:' .$e->getMessage();
};
?>

試したこと

➀Missing file doc comment
訳)ファイルのドキュメントコメントがありません
という事なので下記ドキュメントコメントを追加しました。

/**
 * @file
 * Description
 */


/**
 * Implements hook_menu().
 *
 * Description
 *
 * @return array An array of menu items
 */
$athletes = null;
$races = null;
$ath = null;
$rac = null;
$mydb = null;

$athletes = "SELECT * FROM participating_athletes";
$ath = $mydb->query($athletes);//データ取得
$atheltes_array = $ath;
$json_athletes = json_encode($atheltes_array);

$races = "SELECT * FROM races";
$rac = $mydb->query($races);
$races_array = $rac;
$json_races = json_encode($races_array);

try {
    $mydb = new PDO('mydql:dbname=mydb;host=127.0.0.1;charset=utf=8', 'root', '');
} catch (PDOException $e) {
    echo 'DB接続エラー:' .$e->getMessage();
};
?>

結果はドキュメントコメントに対するエラーが多数出てきてしまい、他の方はドキュメントコードを記載しなくても動いているそうでエラーが起こる原因がわかりません。
すいませんが、ご教授よろしくお願い致します。

退会済みユーザー

2020/02/12 06:06

phpMyAdmin はそういう使い方をするものではないです。

sola-msr

2020/02/12 06:08

phpMyAdminからデータを取得～みたいなの最近みますけどどこかに書いてたりしますの？

jiro-

2020/02/12 06:09

ご返信ありがとうございます。知らなかったです。phpMyAdminの使い方とデータの取得などもう一度調べ直してみます。

jiro-

2020/02/12 06:19

sola-msrさんへ [teratail](https://gray-code.com/php/getting-data-by-using-pdo/) これがphpMyAdminからデータを取得で参考にしたサイトです。

sola-msr

2020/02/12 06:22

このサイトでは > MySQL / MariaDBでデータを取得すると書いてあるので間違いではないです。「phpMyAdmin」はデータベースのクライアントツールであってデータベースではないです。（ここでいうデータベースはMySQLを指します）

退会済みユーザー

2020/02/12 06:26 編集

phpmyadmin は phpで作成されたmysql管理クライアントです。 mysqlを指してません

jiro-

2020/02/12 06:25

ありがとうございます。上記内容修正します。

行動規範の内容に同意します

回答1件

ベストアンサー

drupal - Missing file doc comment? - Stack Overflow

これとか同じ症状ではないですか？

あとはもしかしたらPHP_CodeSnifferとか使ってるなら設定をオフにするとかですかね

もしかして

php
1/**
2 * Implements hook_menu().
3 *
4 * Description
5 *
6 * @return array An array of menu items
7 */

記述でエラーでてたりしません？（何でかいてるんすか？）

投稿2020/02/12 06:11

編集2020/02/12 06:19

sola-msr

総合スコア876

jiro-

2020/02/12 06:34 編集

Stack Overflowのページ見てみたのですが、ご指摘の通り同じ症状だと思います。ファイルの最初の関数を/ **でコメントすることを忘れないでください。そうしないと、コーダーは@fileコメントが最初の関数のコメントであると信じます。自分のコード確認すると/**は付けてます。まさにここのコメントの最初と最後にエラー出てます。 ```PHP /** * @file * Description of what this module (or file) is doing. */ ``` Missing file doc commentの内容がdoc commentが必要となっているから書きました。

jiro-

2020/02/12 06:31

PHP_CodeSnifferは使っていません。

sola-msr

2020/02/12 06:33

その記述はhook_menu()という関数に対してのコメントなので不要だと思いますけど消したらその部分でエラーでますか？（提示されているコードからはhook_menuという関数なんてどこにもみあたらないですけど）

jiro-

2020/02/12 06:37

すいません。記載ミスでした。エラーが出ている箇所はここだけで ```PHP /** * @file * Description of what this module (or file) is doing. */ ``` 下記は消しても問題なかったです。よくわかってないのにコピペでdoc comment貼り付けてました。 ``` /** * Implements hook_menu(). * * Description * * @return array An array of menu items */ ```

sola-msr

2020/02/12 06:45

VSCで入れてるプラグインはわかりますか？

jiro-

2020/02/12 06:49

・AWS Toolkit for Visual Studio Code ・Document This ・Japanese Language Pack for Visual Studio Code ・MySQL ・php cd fixer ・PHP Debug ・PHP DockBlocker ・PHP Extension Pack ・PHP IntelliSense ・phpcs ・Remote - SSH です。 PHP DockBlocker、phpcsというの怪しいので調べてみます。

sola-msr

2020/02/12 06:50

> phpcs これはPHP CodeSnifferのVSC用プラグインです

sola-msr

2020/02/12 06:51

とりあえず無効にしたらエラー出なくなると思います

jiro-

2020/02/12 06:52

ありがとうございます。やってみます！

jiro-

2020/02/12 07:00

setting.jsonファイルに ``` "phpcs.enable": false ``` 追加するとエラー解消しました！長い事付き合ってアドバイス頂き、本当にありがとうございました！