Skip to content

Comment everything. Then, add some comments. #41

@justintadlock

Description

@justintadlock

One of the hardest aspects of reviewing this theme is that, at times, it's impossible to know if a function is doing what it's supposed to be doing. This is simply because there are no inline PHP comments to let me know what something is supposed to do. Now, of course, with some things, this is obvious. However, with other things, it's not so obvious.

Great developers leave comments that explain everything about their code.

I don't care what documentation standard you use or if you use any at all. I just want you to leave docs for your code. But, I will recommend the core WP PHP documentation standard anyway: https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/php/

Not only will documenting help those of us reviewing your code, it'll help others find bugs in the future. And, I can't stress this enough, it'll help you find issues and, perhaps more importantly, understand the code 2, 3, 5 years, or more into the future.

And, just a side note to this: If I were looking through the WordPress.org theme review queue, I'd skip your theme and move on to the next one as a reviewer. I know other good reviewers do this too. From a reviewer's perspective, undocumented code is typically not well-written code, and many reviewers don't want to waste their time. But, that's not really the case with your theme. Compared to many other themes, your code looks fairly solid -- just not documented.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions