Inline docs are the place to track changes. There are better tools for that: revision control. Use Git, Mercurial or – if you want to stay old-school 😉 – SVN.
Each time you change something, you make a commit: A short note explaining the difference between the last and the new version (example).
Usually, when you look at source code you want to know what it does right now. And why. These docs are important. Everything else, including @since, doesn’t really belong to comments.
Related Posts:
- Paginate result set from $wpdb->get_results()
- Change Comment Author Display Name
- comments reply script not working
- How do I set up real anonymous posting in bbpress forums? [closed]
- How do I turn off wordpress comments ability to capture a users ip address?
- Threaded comments – deleting parent comment leads to orphan comments
- How to remove commenters ability to add hyperlinks to comments?
- How can I edit the email sent when a new comment is received?
- How to remove or replace the log-in link for comment replies?
- Exclude internal links from comment moderation?
- Change the HTML output of comments
- Add Comment Custom Field
- Remove link preview in discussion dashboard
- Can’t add default comments to custom post type
- Does Akismet plugin expose any hooks, functions, class that can work with custom code?
- Change language of comments template
- Comments Feed & Custom Post Statuses
- Multiple Comment Forms in a single page [closed]
- Why Allow Script Commands in Comments?
- How to enable comments options?
- WordPress comment count to include attachment comments
- How to no follow the paginated comments
- Remove “Comments are closed” Notice from Custom Post Type template
- Displaying comments with a walker: how to distinguish between parent and child comments
- Count parent comments & replies separately?
- How to modify comments form using comment_form()?
- Capability for allowing user to post own comments without moderation
- Comment count wrong with orphaned comments
- How would I count the number of times a comment meta field’s value is in a post’s entire comments?
- Get comment content by comment ID
- Pings and replies
- stackexchange-like submit comment window
- Retrieve comments from current post using SQL
- Comment_Reply_Link Not Showing?
- Display recent comments with gravatar and excerpts?
- Limit user to one comment
- Is comment metadata included in the export file?
- Get a List of All Commenters on the Current Post
- Display the number of unseen comments on a page since the user last visit
- Log in link not showing, Comment Issue
- Removing the limit on the number of nested comments
- How to call my custom WordPress Comment form without getting the comments?
- How to moderate (manually approve) comments of a specific (registered) User
- How would I add the comment count to this sub-pages of current page snippet
- How can I test why the comment hook is not working?
- How to limit comment author to one comment per post
- Make WordPress process admin group comments using $allowedtags
- How do i remove “Website” field from WordPress comments
- WordPress comments work locally only?
- comment reply by email
- Incorrect redirection after commenting on custom type
- “Discussion” checkboxes unchecked by default on pages? [duplicate]
- How to disable or hide WordPress.com as a social media login option for Jetpack Comments [closed]
- How to limit comment indentations to one level?
- WordPress for questions and responses website
- Minimum allowed comment length only on a specific page
- How can get comment id from comment link?
- How to Add text to the start of all comment?
- How can I count only guests comments?
- How to get comments other than using wp_list_comments?
- Add a Comment on/off option in Screen Options for Comments?
- Pending Comments
- Anonymous spam comments when only registered users can comment
- Limit iframe output in comment-meta commentmetadata
- Get Comment Author ID on the fly while posting
- How / where is the wp_query object created for RSS feeds?
- Separate page for comments using permalinks and add_rewrite_rule
- Return count for characters in the comment and perform action based on the length
- How to load new posts from wordpress db into wordpress homepage without refreshing the site?
- Cannot Remove Title Reply from Custom Comment Template for Signup Page
- comments.php remove date/time’s #hyperlink
- How to make email field not required in comments?
- I have an odd field with a purple background, mentioning HTML-codes to use while leaving comments
- WordPress Comments – Divide by conversation like Medium.com
- I want to limit registered user to 1 comment per post in WordPress
- edit comments in front end
- What is wrong with this? [closed]
- Comment moderation
- I have tried using Plugins to remove 72K comments with no success
- How to get the 5 most recent comments and each comment 5 most recent replies (children)
- How to check if post has previous_comments_link() and next_comments_link()
- Comment text area in single blog post and show comments if approved
- Comments – Ensure the correct field is highlighted for nested replies
- How to ‘If Author’ Comments Check
- selectively disable akismet
- Disqus moderation page not working in WordPress admin section
- Comment Blacklist
- Comment forum to display under the comment you’re replying too
- Recent comments per tagged post?
- WordPress Page Template: Comment Filtering with Querystring
- Modify “Recent Comments” List in WP-Admin
- Comment submission & navigation redirects to default language
- comments are going to spam
- How to hide the login / profile urls on top of comment box for a post
- wp_list_comments adds unnecessary elements
- How to enable truly anonymous posting in bbPress forums? [closed]
- comment awaiting moderation
- How do you fetch the authors email or IP from /comments? (REST API)
- How can I filter the user avatar displayed in comments? – get_avatar_url filter works everywhere but not in comments
- WordPress Editor widgets “comments” and “post comments form” getting disappeared with elementor [closed]