Keep the following tips in mind when deciding how to comment your code:
- You should always write your code as if comments didn't exist, using well chosen variable and function names.
- Comments are meant to communicate to other human beings, not to repeat what is written in the code.
- Various php commenting style guides exist (e.g. pear, zend, etc). Find out which one your company uses and use it consistently!
Command Line Interface (CLI)
This modified text is an extract of the original Stack Overflow Documentation created by following contributors
and released under CC BY-SA 3.0