BugTrack/2588 の編集

* backup.php: PHPDocの記述がいまいち [#n3717675]

- ページ: [[BugTrack]]
- 投稿者: [[ぬぺぺ]]
- 優先順位: 低
- 状態: 提案
- カテゴリー: 本体バグ
- 投稿日: 2022-12-24 (土) 11:46:06
- バージョン: 1.5.4

** メッセージ [#z38c3aee]
PHPDocについてばっかりですみません…

backup.php 中の function get_backup のPHPDocの @return が複数行に分かれているせいで、
 @return String|Array
ではなく
 @return String
だと認識されてVSCodeが文句を言ってきます。

全然バグでもなんでもなくて申し訳ないです…。

VSCodeの問題なのでは？と言われたらちょっと反論しがたいのですが、PHPDocエラーのせいで関係ないエラーが見過ごされて長い間放置されてたこともあったっぽい（[[BugTrack/2579]]）ので、一応修正しておいていただけたら嬉しいです。

***該当コード [#nbbb296e]

backup.php
 /**
  * get_backup
  * バックアップを取得する
  * $age = 0または省略 : 全てのバックアップデータを配列で取得する
  * $age > 0           : 指定した世代のバックアップデータを取得する
  *
  * @access    public
  * @param     String    $page        ページ名
  * @param     Integer   $age         バックアップの世代番号 省略時は全て
  *
  * @return    String    バックアップ       ($age != 0)
  *            Array     バックアップの配列 ($age == 0)
  */
 function get_backup($page, $age = 0)
 {
   :
 }

***修正案 [#xc694bef]

/**
  * get_backup
  * バックアップを取得する
  * $age = 0または省略 : 全てのバックアップデータを配列で取得する
  * $age > 0           : 指定した世代のバックアップデータを取得する
  *
  * @access    public
  * @param     string    $page        ページ名
  * @param     int       $age         バックアップの世代番号 省略時は全て
  *
  * @return    string|array
  *            string    バックアップ       ($age != 0)
  *            array     バックアップの配列 ($age == 0)
  */
 function get_backup($page, $age = 0)
 {
   :
 }

***追記：もう1ヶ所 [#za3b5fc2]

@returnの「Integer」がクラス名だと認識されているようでエラーになっています。「int」が正しそうです。~
（エラーにはなってませんが、他にも何ヶ所かあります）

PHPDocの引数名が実際の引数名と違うところもありますし、そっちも併せてついでに修正していただけたら嬉しいです…~
お手数おかけしてしまって申し訳ないのですが、よろしくお願いします。

backup.php
 /**
  * _backup_get_filetime
  * バックアップファイルの更新時刻を得る
  *
  * @access    private
  * @param     String    $page        ページ名
  *
  * @return    Integer   ファイルの更新時刻(GMT)
  */
 
 function _backup_get_filetime($page)
 {
 	return _backup_file_exists($page) ?
 		filemtime(_backup_get_filename($page)) - LOCALZONE : 0;
 }

***修正案 [#fd8245c6]

/**
  * _backup_get_filetime
  * バックアップファイルの更新時刻を得る
  *
  * @access    private
  * @param     string    $page        ページ名
  *
  * @return    int       ファイルの更新時刻(GMT)
  */
 
 function _backup_get_filetime($page)
 {
 	return _backup_file_exists($page) ?
 		filemtime(_backup_get_filename($page)) - LOCALZONE : 0;
 }

--------
- ご指摘ありがとうございます。わかったものについては反映したいと思います -- [[umorigu]] &new{2022-12-27 (火) 22:59:48};
- よろしくお願いします！ -- [[ぬぺぺ]] &new{2022-12-27 (火) 23:44:26};

#comment

タイムスタンプを変更しない