O'Reilly logo

PHP Application Development with NetBeans Beginner's Guide by M A Hossain Tonu

Stay ahead with the world's most comprehensive technology and business learning platform.

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, tutorials, and more.

Start Free Trial

No credit card required

Chapter 5. Using Code Documentation

Code tells you how, comments tell you why - Jeff Atwood

In this chapter, we are going to document our PHP source code using the NetBeans IDE. We will learn how to quickly document variables, methods, classes, or the entire project, and discuss the following issues:

  • Convention for source documentation
  • How to document the source code
  • PHP project API documentation

Writing great documentation

Coding is the art of instructing machines, and when it comes to human readability, code should be expressive, self-explanatory, and beautiful. The code should be reusable and understandable, so that you can use it again a couple of months from now. A good practitioner makes the code as simple as possible to understand, and keeps ...

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, interactive tutorials, and more.

Start Free Trial

No credit card required