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' );
Related Posts:
- How should I document function calls?
- Local copy of WordPress Codex?
- Is there a top-down documentation for WordPress?
- Where can I find a real architecture document on WordPress?
- WordPress training materials
- User Training Materials
- When should I use @see tag in my inline doc for Functions & Class Methods?
- PHPStorm and CodeSniffer do not recognize WPCS [closed]
- Will php documentation conflict with wordpress documentation?
- documentation on arguements?
- wordpress.com vs local install
- Is there a way to create multiline comments in Python?
- Web scraping redoc web api
- What are the most common Python docstring formats?
- Create html documentation for C# code
- Documentation for using JavaScript code inside a PDF file
- Why is WordPress code so “space-happy”?
- Alternative to query_posts for main loop? [duplicate]
- Why isn’t WordPress part of Framework Interop Group?
- How to name files of namespaced classes?
- Is the codex no longer actively maintained?
- What are all the query parameters for getEntityRecords?
- What’s the difference between the capability remove_users and delete_users?
- Sandwich Coding Standards
- When to use Exceptions vs Error Objects vs just plain false/null
- Actions, functions and conditionals
- WordPress and event-driven programming – what is it about?
- Why does WordPress reverse conditional statements?
- Javascript WP Object Documentation?
- Is there a list / reference for all current native WordPress blocks?
- Is there widely accepted phpDoc syntax for documenting which hook calls a function?
- WordPress objects class reference
- PHP Coding Standards, Widgets and Sanitization
- how to escape wp_oembed_get for phpcs
- Avoiding “Usage of a direct database call is discouraged”
- Using global $post v/s $GLOBALS[‘post’]
- Nonce in settings API with tabbed navigation
- What to do when theme and WordPress coding standards conflict?
- WP Coding standards – escaping the inescapable?
- Gutenberg & Pre-formatted Templates: Core Block Attributes
- Are the default entries for a user in wp_usermeta documented?
- WordPress plugin for authoring technical documentation? [closed]
- What is WordPress file encoding?
- Workflow and best practice for documentation [closed]
- Styling readme.html in plugin?
- How Flexible are the WordPress Coding Standards for PHPCS?
- Correct processing of `$_POST`, following WordPress Coding Standards
- How to set up phpcs with WordPress coding standard with PHP8?
- Are we allowed to use the Allman (BSD) indent style when coding WordPress plugins and themes?
- How to submit documentation with plugin
- Hyphens instead of Underscores in Post-type Archive Template Filenames when Post-type handle contains underscore
- Can I use namespaces in my plugin?
- WordPress documentation – WP_Query arguments
- PHPCS: Strings should have translatable content
- where is the documentation for add_action() parameters?
- Assignments must be the first block of code on a line Validation Error on Travis
- How to incorporate Documentation into wordpress?
- How to view WordPress’ default category IDs?
- WordPress mode for emacs?
- Why does my dissappear?
- Is it better to create a function or a variable for current_theme_supports?
- Prefixing plugin hooks (actions/filters) with a wrapper class or functions
- Strange glyphs code error
- Should I check for privileges before hooking into `wp_ajax_$handle` or after?
- Documentation for adding a tinyMCE view for visual live preview of custom shortcode?
- Add comments for template variables
- Plugin developer automated documentation
- What’s the best practice way of handling custom fields in different post formats?
- What make possible unit test plugins?
- REQUIRED: Could not find wp_link_pages. See: wp_link_pages by Theme Checker
- Translate a Constant while appeasing WordPress PHPCS
- Codex Version Focus on Production or Nightly?
- wp_nav_menu $theme_location parameter ignored
- spaces inside parenthesis
- Why the WP Core team does not allow filter_* functions? [closed]
- WordPress Theme Validator?
- Understanding how the class family `inner-container` works
- Exit or die in main plugin file breaking php standards recommendation
- How to use embed_content hook?
- Is it possible to view WP documentation within the WordPress shell?
- Changing the the_author_posts_link() hover title
- Is there a script to collect all hooks and filters provided by a plugin?
- Check class_exists before class definition / Doxygen problem
- How could I better initialize a method from my class?
- Class or function wrapper for plugin code
- Private pdf files
- Mutliple users editing single document in wordspress
- Is there a common structure for a wordpress formular?
- How indicate when a functions was upgraded in relationship to the entire program [closed]
- Is the default value of FORCE_SSL_ADMIN documented?
- Check if almost 10 year old – working code is up to date
- Callback hooked to post_updated firing on new posts as well
- Should I use wp_cache in my plugin to make it faster?
- WP nonce verification
- Standard technique for AJAX post endpoint: WP REST or WP API?
- Smarter Document Management links between three WordPress sites sought
- PHP Code Sniffer – WordPress VIP Coding Standards
- Adding list of Indexes in wordpress document
- Sanitization html output itself
- Does a codex exist for creating meta boxes in taxonomy