Book Image

PhpStorm Cookbook

By : Mukund Chaudhary
Book Image

PhpStorm Cookbook

By: Mukund Chaudhary

Overview of this book

Table of Contents (16 chapters)
PhpStorm Cookbook
Credits
About the Authors
About the Reviewers
www.PacktPub.com
Preface
Index

Commenting out a section of code and PHPDoc


PHPDoc is a facility provided by PHP, which is meant to document the complex code that you toiled very hard to build. The importance of documenting code and properly documented code need not be explained to those of you who have taken care of someone else's code at some point in their lives. For all others, and for those who know, yet are hungry for knowledge, here are a few points that might explain why you should always document your code—no matter what and how. Stay tuned for some interesting use cases.

Getting ready

You planned to cook PizzaDish. How did you proceed? You created an entity called Dish, designed some functions in it that will assist you in adding some ingredients, and created a special case of the general case Dish. You named this particular case PizzaDish. In order to cook your pizza, you invoked PizzaDish and enjoyed eating your favorite pizza. Things went smoothly. But how many times does it happen that you do not cook other...