phpDocumentor-다른 요소에 대한 주석 참조에 완전한 경로가 필요합니까?

BadHorsie

문서 에서 이것에 대한 명확한 대답을 실제로 해석 할 수 없었습니다 .

예를 들어 @see또는 @param주석의 다른 구조 요소에 대한 참조를 추가 할 때 두 요소가 서로 로컬 인 경우에도 항상 요소의 정규화 된 이름을 사용해야합니까?

예 : 개체 계층

Animals
    --- Mammals
        --- Cat
        --- Dog

Cat 클래스 내에서 Dog를 참조하고 싶다고 가정 해 보겠습니다. 동일한 네임 스페이스에 상주하므로 정규화 된 경로를 제공해야합니까? 어느 쪽이든 중요하지 않다면 모범 사례가 있습니까? 어쨌든 코드를 읽는 개발자의 모호함이나 오해를 제거하기 위해 정규화 된 경로를 사용해야합니까?

namespace Animals\Mammals;

class Cat
{

    /**
     * @param Dog $dog An instance of a Dog.
     *
     * OR
     *
     * @param \Animals\Mammals\Dog $dog An instance of a Dog.
     */
    public function foo(Dog $dog)
    {
        // ...
    }
}
가브리엘 헤밍

아니요, 필요하지 않습니다.

'유형'의 정의

이 유형이 언급 된 컨텍스트에서 볼 수있는 유효한 클래스 이름입니다. 따라서 이것은 FQCN (Fully Qualified Class Name)이거나 네임 스페이스에있는 경우 로컬 이름 일 수 있습니다.

phpDocumentor는 클래스 유형이 문서화 되어야만합니다.

@param

반환 유형이 phpDocumentor에 의해 문서화 된 클래스 인 경우 해당 클래스의 문서에 대한 링크가 제공됩니다.

이 기사는 인터넷에서 수집됩니다. 재 인쇄 할 때 출처를 알려주십시오.

침해가 발생한 경우 연락 주시기 바랍니다[email protected] 삭제

에서 수정
0

몇 마디 만하겠습니다

0리뷰
로그인참여 후 검토

관련 기사

분류에서Dev

ASP.NET ID에 대한 참조가 필요합니다.

분류에서Dev

'Ruby on Rails 4'에 대한 참조 / 교재가 필요합니다.

분류에서Dev

벡터 요소에 대한 참조 주소는 가리키는 벡터 요소와 다른 주소를 갖습니다. 왜?

분류에서Dev

@ImportResource 주석으로 ApplicationContext에 대한 참조를 얻습니까?

분류에서Dev

phpDocumentor 폴더-이 파일에 대한 요약이 없습니다.

분류에서Dev

MVVM 논리 계층에는 Entity Framework에 대한 참조가 필요합니다.

분류에서Dev

비공유 멤버에 대한 VB.net 참조에는 개체 참조가 필요합니다.

분류에서Dev

참조 유형에 대한 설명이 필요합니다.

분류에서Dev

DOM 요소가 console.log에 대한 참조로 전달됩니까?

분류에서Dev

동일한 벡터에 대한 두 개의 참조가 벡터의 각 요소에 대해 서로 다른 메모리 주소를 반환하는 이유는 무엇입니까?

분류에서Dev

주 스레드 이전에 다른 모든 스레드가 완료 되었는데도 .join이 여전히 필요한 이유는 무엇입니까?

분류에서Dev

jQuery Mobile 요소에 대한 ID를 동적으로 생성 한 다음 참조

분류에서Dev

Android Dagger Hilt : ViewModel에 대한 범위 주석이 필요합니까?

분류에서Dev

한 필드가 채워지면 xml에 다른 필드가 필요합니까?

분류에서Dev

Angular2 : 구성 요소 내부의 html 요소에 대한 참조를 가져온 다음 해당 html 요소 위로 스크롤합니다.

분류에서Dev

주석 형 요소에 대한 구문은 무엇입니까?

분류에서Dev

Polymer JS가 한 구성 요소에서 다른 구성 요소로 기능을 전달합니까?

분류에서Dev

GetAbbreviatedMonthName의 비 정적 필드, 메서드 또는 속성에 대한 개체 참조가 필요합니다.

분류에서Dev

비 정적 필드, 메서드 또는 속성 dataGridView1에 대한 개체 참조가 필요합니다.

분류에서Dev

Winforms-비 정적 필드, 메서드 또는 속성에 대한 개체 참조가 필요합니다.

분류에서Dev

다른 요소에 대한 div 병합

분류에서Dev

메모리 주소 변환에 메모리에 대한 추가 액세스가 필요합니까?

분류에서Dev

스레드에 대한 참조를 전달할 때 std :: ref가 정말 필요합니까?

분류에서Dev

다른 경로의 동일한 구성 요소에 대한 Angular 서비스 종속성 주입

분류에서Dev

UIView.animate () : 애니메이션 블록에서 self에 대한 약한 참조가 필요합니까?

분류에서Dev

조건별로 numpy 배열 요소에 대한 참조 얻기

분류에서Dev

REST API 매개 변수가 필요한 다른 매개 변수에 영향을 주어야합니까?

분류에서Dev

CSS 배경 이미지 로딩에 대한 이해가 필요합니다.

분류에서Dev

기존 조건에 대한 PHP 루프가 필요합니다.

Related 관련 기사

  1. 1

    ASP.NET ID에 대한 참조가 필요합니다.

  2. 2

    'Ruby on Rails 4'에 대한 참조 / 교재가 필요합니다.

  3. 3

    벡터 요소에 대한 참조 주소는 가리키는 벡터 요소와 다른 주소를 갖습니다. 왜?

  4. 4

    @ImportResource 주석으로 ApplicationContext에 대한 참조를 얻습니까?

  5. 5

    phpDocumentor 폴더-이 파일에 대한 요약이 없습니다.

  6. 6

    MVVM 논리 계층에는 Entity Framework에 대한 참조가 필요합니다.

  7. 7

    비공유 멤버에 대한 VB.net 참조에는 개체 참조가 필요합니다.

  8. 8

    참조 유형에 대한 설명이 필요합니다.

  9. 9

    DOM 요소가 console.log에 대한 참조로 전달됩니까?

  10. 10

    동일한 벡터에 대한 두 개의 참조가 벡터의 각 요소에 대해 서로 다른 메모리 주소를 반환하는 이유는 무엇입니까?

  11. 11

    주 스레드 이전에 다른 모든 스레드가 완료 되었는데도 .join이 여전히 필요한 이유는 무엇입니까?

  12. 12

    jQuery Mobile 요소에 대한 ID를 동적으로 생성 한 다음 참조

  13. 13

    Android Dagger Hilt : ViewModel에 대한 범위 주석이 필요합니까?

  14. 14

    한 필드가 채워지면 xml에 다른 필드가 필요합니까?

  15. 15

    Angular2 : 구성 요소 내부의 html 요소에 대한 참조를 가져온 다음 해당 html 요소 위로 스크롤합니다.

  16. 16

    주석 형 요소에 대한 구문은 무엇입니까?

  17. 17

    Polymer JS가 한 구성 요소에서 다른 구성 요소로 기능을 전달합니까?

  18. 18

    GetAbbreviatedMonthName의 비 정적 필드, 메서드 또는 속성에 대한 개체 참조가 필요합니다.

  19. 19

    비 정적 필드, 메서드 또는 속성 dataGridView1에 대한 개체 참조가 필요합니다.

  20. 20

    Winforms-비 정적 필드, 메서드 또는 속성에 대한 개체 참조가 필요합니다.

  21. 21

    다른 요소에 대한 div 병합

  22. 22

    메모리 주소 변환에 메모리에 대한 추가 액세스가 필요합니까?

  23. 23

    스레드에 대한 참조를 전달할 때 std :: ref가 정말 필요합니까?

  24. 24

    다른 경로의 동일한 구성 요소에 대한 Angular 서비스 종속성 주입

  25. 25

    UIView.animate () : 애니메이션 블록에서 self에 대한 약한 참조가 필요합니까?

  26. 26

    조건별로 numpy 배열 요소에 대한 참조 얻기

  27. 27

    REST API 매개 변수가 필요한 다른 매개 변수에 영향을 주어야합니까?

  28. 28

    CSS 배경 이미지 로딩에 대한 이해가 필요합니다.

  29. 29

    기존 조건에 대한 PHP 루프가 필요합니다.

뜨겁다태그

보관