A DocBlock is a specially formatted PHP comment which allows external document generators to generate documentation of APIs and helps some IDEs to interpret variable types, provide improved code completion, type hinting and debugging.
Questions tagged [docblocks]
96 questions
0
votes
2 answers
Properly Label Author and Project name in PHP Files?
I simply wanted to know what is the most accepted way to credit yourself and describe the overall package in (preferably) the beginning of the document so other individuals viewing the code have a reference?
I would like to know the answer because…
MrxxMrsSmith
- 3
- 1
0
votes
1 answer
Automatic timestamp during Docblocker creation?
Is there a method to create a live template which would give out the current timestamp by maybe pressing 't' + TAB in phpStorm:
I want to do this in the creation of the DocBlocks as I like to keep a track of the changes in the code, for Ex :
/**
*…
Sankalp Singha
- 4,223
- 5
- 36
- 54
0
votes
1 answer
php storm customize docblock
Is there a way to customize php storm's way of generating the docblocks ?
By default, I would like to have unknown type vars considered as strings.
This is the default way of generating docblock
(using php storm 4.01)
/**
* @param $name
*/
private…
ling
- 7,505
- 3
- 41
- 39
0
votes
1 answer
PHP "namespaced" docblock tags?
I've seen this used (example from Doctrine2) in a lot of libraries that have code which works with comments:
Ivan Pintar
- 1,831
- 1
- 14
- 26
0
votes
1 answer
Is is still proper to include the @param varname in a PHP docblock?
According to wikipedia the format for @param docblock parameters is type [$varname] description where $varname is optional. This seems to be backed by the phpDocumentor project which states:
@param datatype $paramname description
@param…
Xeoncross
- 50,836
- 73
- 238
- 351
-1
votes
1 answer
nodejs router docblock comment
I am writing below docblock for one of my app routers. Is it right?
also, tell me the meaning of each line as I don't know exactly.
/**
* Router serving Activity log page.
* @name get/activity_log
* @function
* @memberof…
saurabh r
- 1
- 2