{"id":1448,"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\/"},"modified":"2018-01-19T19:24:47","modified_gmt":"2018-01-19T19:24:47","slug":"how-to-document-your-php-classes","status":"publish","type":"post","link":"https:\/\/phpbuilder.com\/how-to-document-your-php-classes\/","title":{"rendered":"How To Document Your PHP Classes"},"content":{"rendered":"
\n
\n
By Stefano Locati<\/div>\n
on August 25, 2000<\/div>\n<\/p><\/div>\n
\"picture<\/p>\n
\nSo you’ve read about how Object Oriented programming can help you with your
\nbig web projects and you’ve started it using with PHP? If you’ve already written a
\nhandful of classes to implement a site and you’re methodic, then you should have written
\nsome documentation about them. But If you’re just messy like me you’ve just written
\nsome comments within the classes’ source and no other documentation.
\nWithout documentation it’s difficult to remember methods’ names and the way
\nthey have to be used (parameters and meaning). The typical way to solve this
\nsituation is to have source code files open and to skim through hundreds or thousands of lines.<\/div>\n

Javadoc Like Documentation<\/h2>\n
\nThere must be a better way — if you are used to the Java language you
\nwill know the Javadoc documentation system. This tool allows you to
\ninsert tags within comments of your source files that are then parsed by
\nJavadoc tools in order to generate a set of HTML pages documenting your
\nclasses. So while you program you can keep your browser open and you’ll
\nhave a list of your classes and methods with descriptions. This will
\nbecome your reference to be more productive and fast while building your web application.<\/div>\n
\nIn my opinion maintaining a documentation as a reference within source code
\nis easier and more practical than having to do it in a separated document
\nbecause in this way it’s easier to keep it updated. Otherwise it’s very
\neasy to become lazy and postpone updates in the documentation to a time that never comes. Instead with
\na tool like this there is the little burden to update a tag near the source code you’ve just modified
\nand to run the tool to generate again the updated html pages.<\/div>\n<\/div>\n

<\/p>\n

\n
1<\/div>\n
| <\/div>\n
2<\/a> <\/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 So you’ve read about how Object Oriented programming can help you with your big web projects and you’ve started it using with PHP? If you’ve already written a handful of classes to implement a site and you’re methodic, then you should have written… <\/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-1448","post","type-post","status-publish","format-standard","hentry","category-tutorials"],"_links":{"self":[{"href":"https:\/\/phpbuilder.com\/wp-json\/wp\/v2\/posts\/1448","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=1448"}],"version-history":[{"count":1,"href":"https:\/\/phpbuilder.com\/wp-json\/wp\/v2\/posts\/1448\/revisions"}],"predecessor-version":[{"id":2236,"href":"https:\/\/phpbuilder.com\/wp-json\/wp\/v2\/posts\/1448\/revisions\/2236"}],"wp:attachment":[{"href":"https:\/\/phpbuilder.com\/wp-json\/wp\/v2\/media?parent=1448"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/phpbuilder.com\/wp-json\/wp\/v2\/categories?post=1448"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/phpbuilder.com\/wp-json\/wp\/v2\/tags?post=1448"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}