At times I have seen quite a bit of code posted for review. This might be because there are a number of classes that interact so the person is giving as much information as possible, or they might be posting too much. After the code, or before or even within, there might be updates, or edits.

Does the current avaialable structure for code reviews make the process as easy as possible so people can easily read the code and make comments? Could there be a better way? One thought I had was to have multiple tabs for the various classes, modules etc and a tab for the problem description. So you would seperate the code from the question?

Is there any scope for making site modifications from what seems like the standard exchange template? Or are people happy that the way in which code is presented for review provides an easy mechanism for encouraging people to do more views?

EDIT: Perhaps rather than reviewing the format of posting code reviews an example could be placed up on the site FAQ of what is a good question layout and how to actually as a good question, as well as how to follow up with edit's and changes.

EDIT 11-Nov: Here's an example Mutable JTree style question. The SO has 4 distinct classes and if all put in might actually a fair bit of code. I assume all 4 classes are required to help with the code review. Would not it be easier to read and review this if you could flick through the code in a tab based method much like Visual studio, Eclipse and many other editors and applications that uses tab based format.

Am i flogging a dead horse here because Code review is still in Beta?

share
6  
For simple questions, the current format works well. It fails for iterative reviews and questions with large amounts of code. I believe this is the symptom of a larger challenge: How do we shape our community to comply with the StackExchange ideology where every question has a correct, canonical set of answers? AFAIK our failure to find a solution for that is the main reason we haven't graduated out of beta stage so far. – codesparkle Nov 3 '12 at 22:57
I guess it the large amounts of code and iterative reviews where I see the most confusion in layout and readability of questions. could the lack of finding the answers be a sympton of a lack of ease of understaning in questions? – dreza Nov 4 '12 at 0:24
1  
I think an important question here is whether or not those questions are simply too big? Maybe it should be that they should be split up into a couple of reviews, or be simplified and the advice given applied across the board. – Lattyware Nov 12 '12 at 0:16

You must log in to answer this question.

Browse other questions tagged