phpDocumentor에서 No summary was found for this file.

12549 단어 PHPphpdocumentor

TL;DR


phpDocumentor2에서 PHP7.1 이상의 항목에 대한 문서를 생성하시겠습니까?열심히 읽어주세요GitHub의 자술 파일!
다음은 그곳에 도착하기 전의 기록이다.

현상 1 public const 안 돼요?


다음 파일을 삽입하는 중 phpDocumentor 오류가 발생했습니다.
Awesome.php
<?php
    /**
     * AwesomeなClassを定義するファイル
     */

    namespace MyAwesome;

    /**
     * AwesomeなClass
     */
    class Awesome {
        /**
         * PO は HOGEHOGE とする
         *
         * @var string
         */
        public const PO = "HOGEHOGE";
    }

처리하다


찾다


StackOverflow "phpDoc 블록 두 개를 배치하면 해결"
불평을 잘 못해서 다른 정보를 검색해도 나오지 않았다

절분


상수의doc 주석을 삭제해도 안 됩니다.
Awesome.php
<?php
    /**
     * AwesomeなClassを定義するファイル
     */

    namespace MyAwesome;

    /**
     * AwesomeなClass
     */
    class Awesome {
        public const PO = "HOGEHOGE";
    }
상수로 제거하면 됩니다.
Awesome.php
<?php
    /**
     * AwesomeなClassを定義するファイル
     */

    namespace MyAwesome;

    /**
     * AwesomeなClass
     */
    class Awesome {
    }
함수도 정의할 수 있다
Awesome.php
<?php
    /**
     * AwesomeなClassを定義するファイル
     */

    namespace MyAwesome;

    /**
     * AwesomeなClass
     */
    class Awesome {
        /**
         * po は HOGEHOGE
         *
         * @return string
         */
        public function po(): string {
            return "HOGEHOGE";
        }
    }
No summary was found for this file을(를) public const로 설정하면 됩니다.
Awesome.php
<?php
    /**
     * AwesomeなClassを定義するファイル
     */

    namespace MyAwesome;

    /**
     * AwesomeなClass
     */
    class Awesome {
        const PO = "HOGEHOGE";
    }
삭제const 후doc 주석 추가 가능
Awesome.php
<?php
    /**
     * AwesomeなClassを定義するファイル
     */

    namespace MyAwesome;

    /**
     * AwesomeなClass
     */
    class Awesome {
        /**
         * PO は HOGEHOGE とする
         *
         * @var string
         */
        const PO = "HOGEHOGE";
    }

원인


대상 상수의 접근 범위를 지정하면 안 되는데...?PHP 7.1에서 언어 기능에 추가되었을 텐데...

현상2public의 매개 변수는 안 됩니까?


다음 파일을 삽입하는 중 nullable 오류가 발생했습니다.
Awesome2.php
<?php
    /**
     * Awesome2 を定義するファイル
     */

    namespace MyAwesome;

    use OtherPackage\OtherClass;

    /**
     * Awesomeなclassその2
     */
    class Awesome2 {
        /**
         * 何もしないコンストラクタ
         *
         * @param OtherClass|null $other
         */
        public function __construct(?OtherClass $other) {
        }
    }

처리하다


nullable를 잃어버리세요.
Awesome2.php
<?php
    /**
     * Awesome2 を定義するファイル
     */

    namespace MyAwesome;

    use OtherPackage\OtherClass;

    /**
     * Awesomeなclassその2
     */
    class Awesome2 {
        /**
         * 何もしないコンストラクタ
         *
         * @param OtherClass $other
         */
        public function __construct(OtherClass $other) {
        }
    }
기본 매개변수 지정하기
Awesome2.php
<?php
    /**
     * Awesome2 を定義するファイル
     */

    namespace MyAwesome;

    use OtherPackage\OtherClass;

    /**
     * Awesomeなclassその2
     */
    class Awesome2 {
        /**
         * 何もしないコンストラクタ
         *
         * @param OtherClass|null $other
         */
        public function __construct(OtherClass $other = null) {
        }
    }

원인

phpDocumentor 모델을 지정할 수 없습니다...?PHP 7.1에서 언어 기능에 추가되었을 텐데...

이벤트 3 No summary was found for this file의 반환값은 안 됩니까?


다음 파일을 삽입하는 중 nullable 오류가 발생했습니다.
Awesome3.php
<?php
    /**
     * Awesome3 を定義するファイル
     */

    namespace MyAwesome;

    /**
     * Awesomeなclassその3
     */
    class Awesome3 {
        /**
         * 名前を検証する
         *
         * @param string $name
         * @return string|null
         */
        public function validate(string $name): ?string {
            if($name === "po"){
                return null;
            }else{
                return $name;
            }
        }
    }

처리하다


nullableAwesome3.php
<?php
    /**
     * Awesome3 を定義するファイル
     */

    namespace MyAwesome;

    /**
     * Awesomeなclassその3
     */
    class Awesome3 {
        /**
         * 名前を検証する
         *
         * @param string $name
         * @return string|null
         */
        public function validate(string $name) {
            if($name === "po"){
                return null;
            }else{
                return $name;
            }
        }
    }

원인

phpDocumentor 모델을 지정할 수 없습니다...?PHP 7.1에서 언어 기능에 추가되었을 텐데...

결론


"No summary was found for this file"이라는 잘못된 정보에 속았지만 GitHub의 README에서 쓴 것처럼phpDocumentor2는 PHP7.0만 지원합니다.~완성
순순히 php Documentor3를 기다리세요.현재 RC 버전으로 출시되었습니다.

좋은 웹페이지 즐겨찾기