4
\$\begingroup\$

Source code commenting is essential to the maintainability, readability, and quality of code. Are reviews for such comments on-topic on this site? Alternatively, do we want these types of questions on this site?

\$\endgroup\$
4
  • 1
    \$\begingroup\$ Why do you think this wouldn't be ok? We've had people post answers about this for a long time, many of the results of this search show a specific kind of comment, docstrings, get talked about a lot. \$\endgroup\$ – Peilonrayz Dec 24 '20 at 12:03
  • \$\begingroup\$ @Peilonrayz My point of concern is mostly about the style and volcabulary used in comments. These are technical, so I felt that English.SE (or Chinese, which is what my peers and I speak most natively, or any other language) aren't the best fit. \$\endgroup\$ – DannyNiu Dec 24 '20 at 12:30
  • 1
    \$\begingroup\$ I wouldn't rule out English.SE, or Chinese.SE if it exists, if your question is technical. The Stack Exchange network has a lot of technical people even in non-technical communities. Depending on what you mean by "style and vocabulary" the skills the other sites have could very well be superior to Code Review. \$\endgroup\$ – Peilonrayz Dec 24 '20 at 13:01
  • 1
    \$\begingroup\$ Note, the 4th-highest voted answer is ONLY about the comments: codereview.stackexchange.com/search?tab=votes&q=is%3aa \$\endgroup\$ – rolfl Dec 24 '20 at 21:49
8
\$\begingroup\$

These are called "source code comments" for a reason :)

The help center explicitly stated that "any or all facets of the code" are reviewable. The code presented in the question still needs to fulfil the other conditions for being on-topic.

Notably that means it's not on-topic to ask a question that contains only comments, as those don't do anything. I don't see any reason to explicitly exclude comments from review.

\$\endgroup\$

You must log in to answer this question.

Not the answer you're looking for? Browse other questions tagged .