phpdoc 의견에서 Phpdoc 의견을 피하는 방법은 무엇입니까?
-
21-08-2019 - |
문제
PHPDOC 의견 내에서 PHPDOC 의견을 피하는 방법을 알고 싶습니다.
예를 들어, 이것을 어떻게 작성해야합니까?
/**
* Some documentation...
*
* <code>
* /**
* * Example example phpdoc.
* */
* </code>
*/
분명히 위의 예는 작동하지 않습니다.
나는 별표를 *로 교체하려고 시도했지만 " *"...
해결책
에 따르면 docBlock 설명 세부 사항, 당신은 1.2.0rc1 기준으로 */를 쓸 수 있도록 {@ *}를 작성할 수 있습니다.
예를 들어:
/**
* Simple DocBlock with a code example containing a docblock
*
* <code>
* /**
* * My sample DocBlock in code
* {@*}
* </code>
*/
다른 팁
사용해야합니다 @example
. 태그 다음에 다음 줄을 추가하십시오 </code>
@example /path/to/example.php How to use this function
@example anotherexample.inc This example is in the "examples" subdirectory
추가 정보를 찾을 수 있습니다 여기. 따라서 별도의 파일에 예제 코드가 있어야합니다.
제휴하지 않습니다 StackOverflow