phpdoc

Sometimes in my code I like to comment out a block of code for temporary use/reference etc eg: /* blah */ But it's a minor annoyance that if I then want to go and insert a line inside that block, when I click enter, it will automatically put a * on the next line as though I were doing a DocBlock. This happens on every enter key: /* blah<enter pressed here> * */ Now I would have thought this 'auto-formatting' should only take place if the opening comment is using the format /** (two stars). Multi line comments were around a long time before DocBlocks, so I'm not sure why it forces these "old

In phpDoc-generated documentation I can cause phpDoc to generate a link to a custom type definition for a given param using @param CustomType $variablename and that works great. However, the code I'm currently documenting requires CustomType[] parameters, i.e. an array of said CustomType. I want the documentation to be clear that an array is required, but when I use @param CustomType[] $variablename phpDoc no longer recognizes the type, and thus can't link to it's definition. This is pretty important in this case - I'm documenting an API that has some fairly complex types that need to be

I don't know if this is default behavior or not, but it seems weird to me. I installed WAMP server v2.2e from scratch, with PHP 5.4.3, on a windows 7 machine. I get these minor bugs that i don't really care about (when I activate an extension I sometimes need to exit WAMP and start it again to see the changes), but that's not why I'm here. When I click on the WAMP icon -> PHP -> php.ini, the file I open is the one in the apache directory ( <WAMP dir>\apache\apache2.4.2\bin\php.ini ) The output from the windows cmd command php -i | find /i "Configuration File" outputs <WAMP dir>bin\php\php5.4.3

Hopefully someone here knows a thing or 2 about this. Short Question I am running into an error using phpdoc on the command line, installed via pear on PHP 7.0.2. The error is: #> phpdoc PHP Fatal error: Uncaught Doctrine\Common\Annotations\AnnotationException: You have to enable opcache.load_comments=1 or zend_optimizerplus.load_comments=1. in /usr/local/php5-7.0.2-20160108-102134/lib/php/phpDocumentor/vendor/doctrine/annotations/lib/Doctrine/Common/Annotations/AnnotationException.php:193 How do I fix this error? Details Opcache is enabled and opcache.load_comments=1 is in my opcache.ini file

In a PHP project, even when front controller logic is used for the main application, there can be many stand-alone scripts, ajax snippets and so on. Is there a standardized way - either PHPDoc or something else - to define in the first comment block of the script what GET and/or POST parameters the script will accept / require and of which type they are? I usually help myself by just adding @param s as if the file were a function, and a @return explanation for what the script does and returns, but maybe there is a more specialized way I do not know of. phpDocumentor won't like @param and

How do I document class constants for phpDoc? I've read the manual but I can't find anything about them. I'm fairly sure that you can use @const , though I can't find any English documentation. There's a German example here . It shows define statements rather than class constants, but IIRC the syntax is the same. Nine years later, an edit... It is clear now that the above is bad advice as @const has not appeared in the docs and it seems it will not. Using @var seems to work, though I cannot see it explicitly specified anywhere. ashnazg Constants only need a docblock that contains the