I wanted to ask a question at Code Review, so I visited the FAQ. It says this is ok:

  • Code correctness
  • Best practices and design pattern usage in your code
  • Application UI
  • Security issues in a code snippet, etc.
  • The performance of your code

And this is not:

  • Tools, best practices, improving, or conducting code reviews
  • Trouble-shooting, debugging, or understanding code snippets
  • Higher-level architecture and design of software systems

Is this just a typo? If not, what are the differences between the first and the latter (best practices)? Best practice in your own code should be closely related to best practices in general, or hence it is not best practice.

share
add comment

1 Answer

up vote 12 down vote accepted

Ok, there's clearly room for improvement in the wording here, but what it means is this:

It's on topic to ask us to review your code for best practices (as in "Does this code follow best practices: ..."). But it's off topic to ask questions about best practices (as in "Is it considered best practice for functions to have a single point of return?").

share
3  
This is exactly right. Maybe a rewording is in order. Thinking... –  Michael K May 5 '11 at 21:43
    
Ok, now I know. Thanks! –  whirlwin May 5 '11 at 22:19
2  
@michael definite candidate for rewording. I suggest "code usage of design patterns and best practices for the language" –  Jeff Atwood May 7 '11 at 0:18
add comment

You must log in to answer this question.

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