What is a DocBlock? In this video, I’ll take you to phpDocumentor and discuss what a DocBlock is, as well as why you want to follow this PHP documenting standard. Then you’ll go to the WordPress PHP coding standard for contributing to core.
The reasons why you want to learn how to properly document your code using PHP DocBlock are:
- Human readability – you and anyone else can read your code. You are able to read other people’s code. You know what it requires and what to expect from it when you call that function or method.
- Code – the standard lets you read the DocBlocks in order to do processing.
Don’t repeat yourself. Don’t repeat yourself. Don’t repeat yourself.
Total Lab Runtime: 01:01:34