PhpSorm generate PhpDocs

Hello!

We write the documentation on our script for the 'PhpDocumenter'.
The documentation is only written when the checks were successful.
Is there an example how to write using the tools of 'PhpStorm' documentation for the 'PhpDocumenter'?

Sincerely

Stephan Krauss

6 comments
Comment actions Permalink

I can't comment on the 'conditional' compilation part, not sure what 'checks' you would be referring to? but we use the external commandline config variation for phpdoc and store it in the root project folder as phpdoc.ini.  Then set up an 'external tool' entry that runs phpdoc and the config file.

Program is '$PhpExecutable$'
Parameters  is'C:\xampp\php\phpdoc -c "$ProjectFileDir$"\phpdoc.ini' on my Windows7 system, but the path to phpdoc
Working Directory is '$ProjectFileDir$'

Also have 'Open Console' checked to veiw output

0
Comment actions Permalink

Hello !

Thanks for the quick reply.
Does the PhpStorm tools to help you

in preparing the PhpDoc comments?

Sincerely

Stephan

0
Comment actions Permalink

I don't regenerate the phpdocs that often, but it sure comes in handy for troubleshooting since the output is in the console window at the bottom of the IDE.

0
Comment actions Permalink

Not sure what you mean under "help preparing" but...

Code inspection provides warnings on missing or mismatching PHPDoc comments within editor.
Refactor/Rename operation maintains correct class names in doc references.

0
Comment actions Permalink

Hello!

Thanks for the quick reply.
I am looking for tools that help me a 'phpDoc' build.
I can create the documentation at the end of the work.
For example, the method of a class:
--------------------------

  public function BuildList (array $ list, $ listname) {

         $ test = array ();

         for ($ i = 0; $ i <count ($ list); $ i + +) {
             $ test [$ i] [$ listname] = $ list [$ i] ['foo'];
         }


         return $ test;
     }

----------------------------------------------

Is there a way to 'PhpStorm' the code blocks for
to build the 'PhpDocumenter' touch of a button?

Sincerely

Stephan

0
Comment actions Permalink

1) Enable "Missing PHPDOC" inpection
2) Invoke "Generate" quickfix on its messages - either in editor or on batch analysis results.

Also typing /**<ENTER> will generate a doc for function below it.

0

Please sign in to leave a comment.