The forums have permanently moved to forum.kirupa.com. This forum will be kept around in read-only mode for archival purposes. To learn how to continue using your existing account on the new forums, check out this thread.


Results 1 to 3 of 3

Thread: Document PHP Classes

  1. #1

    Document PHP Classes

    I'm reading another book about OOPHP and trying to figure out a way to document my classes for future use. The OOPHP book recommends phpDocumentor: http://phpdoc.org/

    Anybody has an opinion or any suggestions as to how to document your classes for your own future reference? Or maybe to share it?
    "You are playing a very dangerous game"
    "Change always is"

    Creativo Development

  2. #2
    that's pretty much the php standard. you can document it however you want tho
    Let us live so that when we come to die even the undertaker will be sorry. - Mark Twain
    Don't PM me your CSS, xHTML, JS or PHP questions. I will not reply to ANY IE6 questions.

  3. #3
    Javadocs is quite popular and supported by many IDE's:

    PHP Code:
    class MyClass
    {
       
    /**
        * detailed description of myFunction
        * 
        * @param string $myParameter Description of myParameter
        * @return int Description of what it returns
        * @global array $_SESSION['someInteger']
        */
       
    public function myFunction($myParameter)
       {
          return 
    $_SESSION['someInteger'];
       }


Thread Information

Users Browsing this Thread

There are currently 1 users browsing this thread. (0 members and 1 guests)

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •  

Home About kirupa.com Meet the Moderators Advertise

 Link to Us

 Credits

Copyright 1999 - 2012