techdoc centre
本站搜索 用户名: 密码:
   HOME  TECHDOC  WEB  SDK  NSDT  TOPIC  BIZDOC   LOGIN
  发布地区 Global 发布类别 SDK Php
字体:
  phpdocument - PHP代码文档自动生成工具
于 2017-10-17 编辑: Eric 查看: 1211 次   Article Url Print this page

It’s a common problem amongh developers that insufficiently or no documentation of code causes problems, delays, misunderstandings. Even code you wrote yourself could look really strange after a while, when you no longer remember what’s exactly going on. At this point a good documentation could help you save time and nerves.

PhpDocumentor is a good script that generates documentation for your code based on inline comments in your script files. It can generate various output formats, has different themes, and is very customizable. It only requires that you actually commend your code.

You can read how to comment your code easily in the PhpDocumentor manual. There are a few useful samples and general descriptions of all tags etc. you can use in your code.

The actual usage of PhpDocumentor is really simple. You just need to download the package, place it somewhere accessible via a browser, and you get a nice webinterface to create your documentation. Remember that PhpDocumentor needs proper read/write permissions to your project files and the documentation destination folder, where you docs are stored. It’s all described in the PhpDocumentor manuel, and you should be able to have a finished documentation of your project within just a few minutes (plus the time to actually write the needed comments). As time passes you will hopefully learn to comment your code as you write it, so the generation of the documentation becomes a continous, easy and natural part of your development. I’m sure this will ease your work!

Sample commented class

/**
* My class
* Provides my own functions for my own purpose. Really cool!
* @package mystuff
*/
class MyClass {
  /**
   * @var string $myvar The most important variable.
   */
  var $secondvar = 42;

  /**
   * Function that does something.
   * @param string $what to do.
   * @return boolean true if it could be done, false if no.
   */
  function doSomething($what) {
   return true;
  }
}

http://www.facebook.com/note.php?note_id=467443035758


网址: 相关网址

相关文章:

o phpMyFAQ - open source FAQ system for PHP and MySQL
o Solar - PHP 5 framework for web application development.
o PHPMailer
o 22个开源的PHP框架
o 9个强大免费的PHP库
o 20 你应该知道的PHP库
o 使用PHP调用TinyURL API的方法
o xajax PHP Class Library
o XML-RPC for PHP
o Beautify PHP source code


   Search:

   

   Categories:

 Open All Close


Copyright techdoc.netsoftlab.ca powered by netsoft lab. 2007-2012  
Friend Websites:   netsoftlab.ca   cnstar.ca   CS lessions