What can you do with a DocBlock in PHP?

Using a DocBlock you are able to effectively document your application’s API (Application Programming Interface) by describing the function of, and relations between, elements in your source code, such as classes and methods.

What are the features of phpdoc.de documentation?

This package has many features: ability to parse any PHP file, regardless of documentation format is designed specifically for PHP, and so documents all constants, functions, classes, methods, and class variables *NEW 0.4.1* complete phpdoc.de DocBlock tag support.

What are the elements of a PHP Doc?

They may contain any of the standard PHPDocumentor elements (class, function, class method, class variable, define). A Package-level doc is an html file with the same name as the package that is located in the same directory as one of the physical files that contains a package element.

What’s the difference between a DocBlock and a doccomment?

In reality a DocBlock is in fact the name for a combination of a, so-called, DocComment and a block of the PHPDoc Domain Specific Language (DSL). A DocComment is the container that contains documentation that can be formatted according to the PHPDoc Standard.

Where can I find the docblockr package manager?

DocBlockr is a package for Atom which is designed to make writing documentation faster and easier. Use the Atom package manager, which can be found in the Settings view or run apm install docblockr from the command line. The main development branch is develop and the stable ‘production’ branch is master.

Is there a docblockr port for Visual Studio?

A Visual Studio Code port of the Atom package Docblockr. Currently three languages have been implemented: Vue.js More languages will be implemented in the future. Type /** above the code you want to apply a docblock too, and press enter.

How to determine the type of a variable in docblockr?

Press space or shift + enter after an opening /** to insert an inline docblock. DocBlockr will also try to determine the type of the variable from its name. Variables starting with is or has are assumed to be booleans, and callback, cb, done, fn, and next are assumed to be functions.