- Viewed 10k times
10
answered Feb 21, 2010 at 14:11There is no "real standard" about what should be commented and how, but some tags are used by pretty much anyone who comments his code.
For instance, I generally use at least :
a short descriptions
optionnally, a long description
...$]*]
/*** @package Zend_Cache* @subpackage Zend_Cache_Backend* @copyright Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)* @license http://framework.zend.com/license/new-bsd New BSD License*/class Zend_Cache_Backend_Apc extends Zend_Cache_Backend implements Zend_Cache_Backend_ExtendedInterfaceContent Under CC-BY-SA license WEBFeb 26, 2010 · I have tried to find out what best practices are of using phpDoc in Eclipse, but with pretty slim results. Can you share your best practices and tricks of using phpDoc to comment stuff in Eclipse?
Explore further
WEBWhen running phpDocumentor there are three command-line options that are essential: specifies the directory, or directories, of your project that you want to document. specifies a specific file, or files, in your project that you want to document. specifies the location where your documentation will be written (also called 'target folder').
WEBphpDocumentor is the de-facto documentation application for PHP projects. Your project can benefit too from more than 20 years of experience and setting the standard for documenting PHP Applications.
WEBphpDocumentor is the de-facto documentation application for PHP projects. Your project can benefit too from more than 20 years of experience and setting the standard for documenting PHP Applications. With these tutorials, guides and references we aim to provide you with all the information that you need to optimally document your code and ...
WEBDec 6, 2011 · phpDocumentor is designed to make the task of documenting minimally redundant. This means less work, and better, up-to-date documentation with less effort than it used to take. phpDocumentor is a great tool, but it will not write good documentation for you. Please read the phpDocumentor Guide to Creating Fantastic Documentation
WEBThe basic usage of phpDocumentor is to provide an input location using the command line options ( -d for a directory, -f for a file) and tell it to output your documentation to a folder of your liking ( -t ). For example: $ phpdoc run -d ./src -t ./docs/api. What the above example does, is scan all files in the src directory and its ...
- People also ask
WEB43 rows · Features. phpDocumentor supports the following: PHP 7.0+ compatible, full support for Namespaces, Closures and more are provided. Docblock over types, docblocks can be more explicit about types not all …
Michael Angstadt's Blog: Using phpDocumentor with Eclipse
WEBAug 6, 2009 · Using phpDocumentor with Eclipse ... I decided to use phpDocumentor because the format it requires the comments to be in is nearly identical to Java's Javadoc, which I was already familiar with. I wanted to set up an Ant target that I could run that would generate the HTML documentation. It was pretty straight-forward--just create a target ...
Using PHPDoc With PHP 7 - And Actually Making it Work
WEBJuly 22, 2019 14 minutes. Requirements. PHP7. IDE such as Visual Studio/Visual Studio Code. PHPTools. PHPDocumentor2. Overview. If you've been developing for any length longer than about 5 minutes, there's a good chance that someone has told you about the importance of properly documenting your code.
Code Documentation Using phpDocumentor | PHPEclipse: A User …
WEB1. Overview of Eclipse and PHPEclipse; Integrated Development Environments; IDEs in Development Projects; Eclipse; The Eclipse Architecture; Why Use Eclipse? PHPEclipse; Summary
- Some results have been removed
Skip to content
