documentation on arguements?
They’re all in the codex page for WP_Query.
documentation
Do define() statements need phpDocumentor-style docblocks?
I would say the section Constants in the WordPress: PHP Documentation Standards is pretty clear. It should look like this: /** * Summary. * * @since x.x.x (if available) * @var type $var Description. */ define( ‘MY_CONST’, ‘Hello’ );
Will php documentation conflict with wordpress documentation?
I believe the practice of including additional data within PHP code comments is typically called annotations. WordPress core makes no use of annotations technique for any code runtime tasks and doesn’t have an API for such purpose. In number of context it will read file headers to extract meta data, such as main plugin files … Read more
PHPStorm and CodeSniffer do not recognize WPCS [closed]
PHPStorm and CodeSniffer do not recognize WPCS [closed]
When should I use @see tag in my inline doc for Functions & Class Methods?
“@see” tag is used somehow randomly No wonder as any documentation in the end depends on the programmer’s decision of what is worthy of being documented and how. Documentation in general should not be a verbal description of the code unless the code is extremely non trivial, but add a human friendly summery of what … Read more
User Training Materials
Interconnect/Spectacula folks manage free WordPress User Guide for training users.
WordPress training materials
VTC and Lynda have very good training videos on this.
How should I document function calls?
You don’t document function calls, but function definitions. Because the function could be called unlimited times, right? So it makes no sense to document functions when they are called. If you document the call, then probably because you do some things you want to remember later – or let other following developers know. But normally, … Read more
Where can I find a real architecture document on WordPress?
I’m not aware of any besides michel fortin’s WP text flow diagram from a few years ago: http://michelf.com/weblog/2005/wordpress-text-flow-vs-markdown/ That said, there were recent talks about writing some kind of plugin dev’s companion reference with the full flowchart of the WP hooks and API.
Is there a top-down documentation for WordPress?
WordPress is very… utilitarian I suppose. People tend to use and know as much as they need to get things done. Curiously that tends to exclude the low level core load process. It doesn’t help the situation that (unlike modern frameworks) WordPress doesn’t use a complete routing logic for everything. Front-end is governed by rewrite/permalinks, … Read more