{"id":1449,"date":"2018-01-19T19:22:51","date_gmt":"2018-01-19T19:22:51","guid":{"rendered":"http:\/\/goofy-trucks.flywheelsites.com\/how-to-document-your-php-classes-page-2\/"},"modified":"2018-01-19T19:24:48","modified_gmt":"2018-01-19T19:24:48","slug":"how-to-document-your-php-classes-page-2","status":"publish","type":"post","link":"https:\/\/phpbuilder.com\/how-to-document-your-php-classes-page-2\/","title":{"rendered":"How To Document Your PHP Classes Page 2"},"content":{"rendered":"
\n
\n
By Stefano Locati<\/div>\n
on August 25, 2000<\/div>\n<\/p><\/div>\n
\n

Overview of Some Php Documentation Tools<\/h2>\n
\nHaving all of this on mind I have been looking for what was available
\nand I have discovered some interesting tools like the following ones:<\/div>\n
\nphpSearchdoc<\/a> is a component of the enzyme project.
\nSince enzyme is a big project there was the need of documenting it.
\nTheir developers have been writing their own documentation system and they have been kind enough to release it also
\nas an independent package.
\nThe documentation gets first written into a database and then it can be viewed with some PHP scripts
\nas a dynamic web site.<\/div>\n
\nThe idea to separate parsing logic from presentation is indeed good, however phpSearchdoc (version 1.01)
\ndoesn’t have a real parser but looks for keywords anywhere in the source, even within comments.
\nIn fact, it really have happened to me to have the word ‘function’ within my comments, and yes, the parser got
\nfooled by thinking that the words following this word were the function’s name. Unfortunately then, I was unlucky
\nto have an apostrophe (‘) in the same line, and when I was trying to write data into the database, mysql has
\ncomplained (the apostrophe is used to delimit strings in mysql).<\/div>\n
\nFurthermore it’s really difficoult to set up and get it working since it’s still in alpha state. And after
\nall it’s more a cross reference generator than a documentation system because, as far as I know, you can’t
\nadd your own comments to functions or methods.<\/div>\n
\nphpxref<\/a>, as the name suggests seems to be more
\noriented to the generation of a cross reference than a real documentation. Further it seems to be suited more for a
\nregular procedural programming rather than for object oriented programming.<\/div>\n
\nphpautodoc<\/a> aims to be for PHP what
\nJavadoc is for Java. It seemed to be the perfect solution for my documentation needs. To try it out I had to
\ncompile the CGI version of PHP (I normally use the module version), because the generator is written in PHP.
\nI could compile and install the static executable on a Linux system easily with these commands:<\/div>\n
\n
\nrm config.cache\nmake clean\n.\/configure\nmake\ncp php \/usr\/local\/bin\n<\/pre>\n<\/div>\n<\/div>\n
<\/p>\n
\n
\u00ab Previous Page<\/a><\/div>\n
1<\/a> <\/div>\n
| <\/div>\n
2<\/div>\n
| <\/div>\n
3<\/a> <\/div>\n
| <\/div>\n
4<\/a> <\/div>\n
| <\/div>\n
5<\/a> <\/div>\n
Next Page \u00bb<\/a><\/div>\n<\/div><\/div>\n","protected":false},"excerpt":{"rendered":"
By Stefano Locati on August 25, 2000 Overview of Some Php Documentation Tools Having all of this on mind I have been looking for what was available and I have discovered some interesting tools like the following ones: phpSearchdoc is a component of the enzyme project. Since enzyme is a… <\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[3],"tags":[],"class_list":["post-1449","post","type-post","status-publish","format-standard","hentry","category-tutorials"],"_links":{"self":[{"href":"https:\/\/phpbuilder.com\/wp-json\/wp\/v2\/posts\/1449","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/phpbuilder.com\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/phpbuilder.com\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/phpbuilder.com\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/phpbuilder.com\/wp-json\/wp\/v2\/comments?post=1449"}],"version-history":[{"count":1,"href":"https:\/\/phpbuilder.com\/wp-json\/wp\/v2\/posts\/1449\/revisions"}],"predecessor-version":[{"id":3306,"href":"https:\/\/phpbuilder.com\/wp-json\/wp\/v2\/posts\/1449\/revisions\/3306"}],"wp:attachment":[{"href":"https:\/\/phpbuilder.com\/wp-json\/wp\/v2\/media?parent=1449"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/phpbuilder.com\/wp-json\/wp\/v2\/categories?post=1449"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/phpbuilder.com\/wp-json\/wp\/v2\/tags?post=1449"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}