code-review

What are the good code review/walkthrough techniques?

Our team is pretty committed to code walkthroughs. I define a walkthrough as: Where two people sit down next to a computer and look at a diff prior to committing. I do find them to be very time consuming, but it is often the case that good results are generated from such a procedure. So my question is, what is the single technique/...

Comparison of Code Review Tools/Systems

There are a number of tools/systems available aimed at streamlining and enhancing the code review process, including: CodeStriker Review Board, code review system in use at VMWare Code Collaborator, commercial product by SmartBear Rietveld, based on Modrian, the code review system in use at Google Crucible, commercial product by Atlass...

What tags do you use in the tasklist (e.g. Visual studio 2008)

In our code, we currently use the following tags that can in turn be listed in the visual studio's tasklist: TODO to mark tasks inside the code the need to be done // TODO: optimize this loop HACK to mark code that is only there to make something work for the moment, for instance for a presentation // HACK: assume we know the users ...

Prevent Legacy Function Calls In VB.NET

Within Visual Studio 2008, what would be the easiest way to prevent usage of certain functions from being allowed? Specifically, I'm trying to prevent other developers from using "old school" VB6-style commands such as: Len LCase UCase Instr InstrRev Trim Right Left Mid etc., etc., etc.... The list goes on and on. I can usually ca...

Need help improving a Ruby DSL for controlling an Arduino controlled drink dispenser (bar monkey)

I'm writing a DSL in Ruby to control an Arduino project I'm working on; Bardino. It's a bar monkey that will be software controlled to serve drinks. The Arduino takes commands via the serial port to tell the Arduino what pumps to turn on and for how long. It currently reads a recipe (see below) and prints it back out. The code for se...

Improving code readability for SQL commands

In one of my classes for a web application I am developing, I have some reasonably long SQL queries. When developing a three-tier application, what are the best practices to make this kind of code neater? Dim dc As New SqlCommand("INSERT INTO Choices VALUES ('" + _ SanitizeInput(strUser) + "', '" + _ ...

How do I provide good documentation in my code?

I am always wondering what should I write for inline code documentation? I always end up with one liners "This function does x" or a 4 paragraph essay describing every micro detail of the function. I am trying to find a balance that provides good documentation without being to verbose. So if you could replay with the one thing that yo...

How to filter items from a std::map?

I have roughly the following code. Could this be made nicer or more efficient? Perhaps using std::remove_if? Can you remove items from the map while traversing it? Can we avoid using the temporary map? typedef std::map<Action, What> Actions; static Actions _actions; bool expired(const Actions::value_type &action) { return <something>...

Persuading developers to fix smelly but working code?

In our company, developers always have dozens of important tasks assigned and tight deadlines in which to complete them. In this environment, a code review often shows that their program will execute correctly but is "smelly", i.e. hard to read, hard to maintain and a potential breeding ground for bugs. How do you persuade developers (...

What are the pros and cons of design/code reviews?

Design reviews pre-implementation I am assuming ensures a good design the better meets the requirements of a project. Code reviews during implementation ensure that the coder properly translates the design into actual code. Are design reviews necessary? Pros and cons. ...

What is the single most important project vital sign to track that will help evaluate project health?

Just like human beings have vital signs (e.g. temperature, heart rate, blood pressure, and breathing function); what vital signs are essential to collect and track to aid in the evaluation of the overall health of a project? No clear winner yet based on the voting to date (June 2009). ...

How to revoke individual code ownership

While reading this other question, I wondered me about this opposite. I was in a project mainly driven by only one guru developer. Then, me and another three people were added to the project. But the time went on and for every feature needed, its implementation required constantly intervention of him because we were not very knowledgeab...

pre-commit code review

I'd like to have such scenario: I have a repository and lots of folks committing to it. For some of them I prefer looking at their code first, before allowing them to submit their code. There are many good code-review tools, but none actually allows me to easy support this workflow: Edit your code. Easily submit your code from within ...

Showing off your modules and processes (graphically)

One of our programmers came today with an interesting question: How can we show graphically of system ruining with a flow chart or something like that. The solution we are looking for has to be pretty simple. We intend to use this "animated flow chart" to show how our system is supposed to work to our non-tech staff. We need their feedb...

Code review for VS

looking for a good code review tool that plugs in nicely to Visual Studio. Would be nice if it could diff from different source control providers, like Source Safe, The Vault, and/or Subversion. ...

Web Apps for Source Code Discussion

Are there any web apps that allow for source code collaboration? I'm thinking of something that could look at an SVN repo/local folder/etc. and publish the code with support for threaded discussions under each file or class. Ideally I want to find something that I could deploy/host myself, so being based in PHP would be a huge plus. ...

Has anyone tried Divmod's "Ultimate Quality Development System"?

Ultimate Quality Development System Does anyone have any experience with this or a similar methodology, good or bad? ...

Is WHILE TRUE...BREAK...END WHILE a good design?

I've been looking at some code recently where the author used something similar to this (pseudo-code): WHILE TRUE OpenAFile IF Failed BREAK ENDIF DoSomething IF NOT OK BREAK ENDIF ...etc... BREAK END WHILE Arguments for using this design was speed (due to 'fall through' routines) and...

Reducing coding standards 'brainwashing' duration and effort of new hires.

At my current job we're pretty strict about code quality and coding standards. All new hires go through a 'brainwashing' period in which time senior developers coach them to write (hopefully) better code. The code review process is meticulous and it normally halves the productivity of the developers doing the review. And sometimes the '...

Automating code review and refactoring

I'm trying to do automated code review and refactoring with a tool. Something in the lines of FxCop or ReSharper. Looking for tool suggestions that meet these requirements: Low learning curve. Targeted at C# (and maybe VB.NET). Let's me easily add or customize rules (and understands entire CodeDOM). Well documented. FREE or dirt cheap...