guidelines

What is your favorite Coding Guidelines Checklist?

What is your favorite Coding Guidelines Checklist? I don't think one list will satisfy everyone. So the "favorite" part :) I was about to ask for Embedded programming and C at first. But you can post your favorite in other languages / areas as well. ...

Guidelines to improve your code

What guidelines do you follow to improve the general quality of your code? Many people have rules about how to write C++ code that (supposedly) make it harder to make mistakes. I've seen people insist that every if statement is followed by a brace block ({...}). I'm interested in what guidelines other people follow, and the reasons behi...

Beta Test Guidelines / Agreement

I'm going to roll out a private beta soon but never participated myself in something like that. So which points should be included in a beta test agreement between me and the users? Pointing me to an example agreement would be a plus. Edit: It's a B2C application. Not related to security. ...

Code formatting: is lining up similar lines ok?

I recently discovered that our company has a set of coding guidelines (hidden away in a document management system where no one can find it). It generally seems pretty sensible, and keeps away from the usual religious wars about where to put '{'s and whether to use hard tabs. However, it does suggest that "lines SHOULD NOT contain embedd...

Should you enforce coding practice on your third party development team?

I've written up a number of guidlines on codeing practice for a third party developer. One such practice is that no vb file should build up HTML in the code behind. Any HTML should appear in ASCX or ASPX files (so our web designers don't have to learn vb). Every time they release code it contains numerous stringbuilders. How can enforce ...

What guidelines for HTML email design are there?

What guidelines can you give for rich HTML formatting in emails while maintaining good visual stability across many clients and web based email interfaces? An unrelated answer on a question on Stack Overflow suggested: http://www.campaignmonitor.com/blog/archives/2008/05/2008_email_design_guidelines.html Which contains the following g...

Best rule for maximum function size?

In another question, a popular answer suggested that large functions demonstrate poor form. How large would you let a function get before you broke it up? (This could be in lines of code or a more qualitative answer, your choice. This is probably a language-dependent question to some extent, so you might want to indicate that and how ...

What are the best practices for handling Unicode strings in C#?

Can somebody please provide me some important aspects I should be aware of while handling Unicode strings in C#? ...

How to choose and optimize oracle indexes ?

I would like to know if there are general rules for creating an index or not. How do I choose which fields I should include in this index or when not to include them? I know its always depends on the environement and the amount of data, but I was wondering if we could make some globally accepted rules about making indexes in Oracle. ...

Why is it better to use readonly properties verses functions?

I see little functional difference between using a property public readonly property foo as string get return bar end get end property or a function public function foo() as string return bar end function Why would I want to use one form over the other? Thanks! ...

How do you format your Compound Statements in Delphi and C#?

As a long time Pascal and Delphi developer, I always line up my begin and ends thus : begin if x = y then begin ... ... end else for i := 0 to 20 do begin ... ... end; end; What drives me nuts is code formatted thus : begin if x = y then begin ... ... end else for i := 0 t...

Do you add information to the top of each .hpp/.cpp file?

When creating a new C++ header/source file, what information do you add to the top? For example, do you add the date, your name, a description of the file, etc.? Do you use a structured format for this information? e.g. // Foo.cpp - Implementation of the Foo class // Date: 2008-25-11 // Created by: John Smith One team I know embeds...

Java Programming Guidelines

What Java Programming Guidelines you are using? I know that the most common is the one provided by Sun (http://java.sun.com/docs/codeconv/) but I would like to know if there are other market standards. ...

How to chose between new and override in C#?

It is advised to use override instead of new key word in C#. Why that rule? ...

What should coding guidelines do, and are there any good examples of guidelines?

What are some good examples of coding guidelines. I'm not really looking for anything specific to a single language. But what should I be doing/evaluating as I write coding guidelines? Such as how flexible should the guidelines and how much should decisions be left to the programmer or to someone else or even pre-decided by the guidelin...

Is there source code analysis api in .net similar to those in java?

The APIs that might be of interest to developers of Java applications that need to perform source code analysis are the Java Compiler API (JSR 199), the Pluggable Annotation Processing API (JSR 269), and the Compiler Tree API. Any similar api or library for .net? ...

Is there a recommended number of lines of code per file?

Hello, I have a class file that contains all the classes that are needed for a certain web application. Currently I'm at line 7269 and it contains numerous classes. I'm not particularly worried but I've started to notice that when working on this file Visual Studio responds slower. I'm thinking that this may be caused by the size of the...

"Best Practices" for a software research and development team?

I have seen numerous articles and questions here on SO regarding best practices for software development in general. I am however after more specific best practices or guidelines focussing more on the research area for and R&D team. For example, i have read that Google allows their developers to work on personal projects for one day per...

What would be the best programming guideline/tip

What would be the best programming guideline/tip to follow to become a better programmer? My favorite one is from the book The Pragmatic Programmer: From Journeyman to Master Don't Live with Broken Windows Their case is: One broken window, left unrepaired for any substantial length of time, instills in the inhabitants of the buil...

How to do a Software usability evaluation

Most of the guidelines and checklists available on the internet are for "web usability" is there any checklist for "software usability"? ...