Я хотел бы знать, как избежать комментариев phpdoc в комментарии phpdoc.
Например, как мне это нужно написать:
/**
* Some documentation...
*
* <code>
* /**
* * Example example phpdoc.
* */
* </code>
*/
Очевидно, что приведенный выше пример не будет работать.
I tried replacing the asterisk with *, but it will just nicely print "*"...
В соответствии с 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
Вы можете найти дополнительную информацию здесь. Таким образом, вам, видимо, также нужно иметь пример кода в отдельном файле.