tags:

views:

107

answers:

4

I have a medium small open source project that I am wanting to release, but first I would like to do a code review to check to make sure everything works and, most importantly, makes sense. I already (sorta) do the first part by having my own implementation of the project that I use heavily. But the second part is more tricky.

How can you check a project to see if it makes sense if you wrote it? Everything makes sense to you, but to others new SomeObject(new SomeEvent(new YetAnotherNestedObject() { public void someImplmentation { ... might not (that was only an example). I just can't think of a way to effectively say "This makes sense". I don't even think I could catch bugs that way.

Any suggestions?

(and should this be Community Wiki? Not sure)

+10  A: 

Rubber duck debugging. Basically, try explaining it to someone else, even if that's an inanimate object.

Another good strategy is to sleep on it, or take a break from your code for a while. You may have more insights when you come back.

jtbandes
+1 Whoa, didn't even know such a concept existed. I'll do Weighted Companion Cube debugging instead though... a rubber duckie belongs in a bathtub, not my desk.
BoltClock
Thats... interesting. Could you experience something similar to this when just writing tons of documentation?
TheLQ
Yeah, that's very possible. Basically, if you're trying to explain the code, you're much more likely to come across things that don't make sense. Whereas, when you're on a roll coding, you might get confused and think they made more sense than they really do.
jtbandes
I think thats what I'll do then, since a goal of my project is to document as much as possible. Thanks for the help
TheLQ
A: 

testing. Its not a code review, but it gives you maintainability and validation.

Is this something you have done before, or new stuff?

Do you have any friends who you can run it by?

hvgotcodes
Unfortunately no. I don't know too many people in the programming community that well to just hand over the entire project and say "Does it make sense?".
TheLQ
+1  A: 

You can't. The whole point of a code review is to get a second pair of eyes to examine the code. You should ask a friend to do a review.

willcodejavaforfood
Unfortunately I don't know anybody that can do this, or know some people well enough to hand over the entire project and say "Does it make sense?"
TheLQ
+1  A: 

If you mean you want to have the code reviewed before you open it for contributions, but don't mind others seeing the code, you could try your luck at the Review My Code Reddit. It's been a little passive lately, but might not hurt to try.

fencliff
Hmm, I've never heard of a code review site. I'll take a look
TheLQ