Return to Answer

In a recent answer, @AJMansfield wrote:

That passes the test, in my opinion, because "Replaced configuration parser with a solution based on java.util.Properties" suffices as a commit log message. Some additional detail would have improved the answer, but the original answer was sufficient. Despite being just one sentence, it was amazingly insightful, enough to trigger a "Why didn't I think of that?" moment. I voted for that answer, and would do so again.

A second example of a short, valid answer by @Josay:

Here's an example of a comment that should have been an answer instead:

Note that only short answers need to pass the commit log message test. There are other styles of critique for which the test doesn't make sense.

In a recent answer, @AJMansfield wrote:

That passes the test, in my opinion, because "Replaced configuration parser with a solution based on java.util.Properties" suffices as a commit log message. Some additional detail would have improved the answer, but the original answer was sufficient. Despite being just one sentence, it was amazingly insightful, enough to trigger a "Why didn't I think of that?" moment. I voted for that answer, and would do so again.

A second example of a short, valid answer by @Josay:

Here's an example of a comment that should have been an answer instead:

Note that only short answers need to pass the commit log message test. There are other styles of critique for which the test doesn't make sense.

Conversely, a good guideline for what should be a comment is that comments should be treated as disposable. "Your code doesn't make sense at all" might be better as a comment, especially if you think that the original poster needs to fix the code in preparation for review.

Conversely, a good guideline for what should be a comment is that comments should be treated as disposable. "Your code doesn't make sense at all" might be better as a comment, especially if you think that the original poster needs to fix the code in preparation for review.