Click here to Skip to main content
11,584,208 members (41,680 online)
Click here to Skip to main content

Some habits of successful programmers

, 23 Feb 2015 CPOL 162.5K 51
Rate this:
Please Sign up or sign in to vote.
Tips to make you a better citizen in the developer community.

1. Code for human consumption

It is one of the most pervasive misunderstandings in computing that the source code is for the computer's consumption. Computers work with low-level binary code, a series of impenetrable 1's and 0's or hexadecimal numbers, not the structured high level languages we code in. The reason that these languages were developed was to help the programmer.

In practice, coding for human consumption often means coding for clarity first, over efficiency and cleverness second.  This is not to condone bad / inneficient code but rather to address premature optimization and optimization that costs maintainability. 

2. Comment often and comment well

The comment is the extreme example of a language element for human consumption (most compilers will strip the comments from the executable program). The purpose of the comment is to tell you (and any future developer) what the program is intended to do. Write comments with this in mind - and avoid simply restating the code.

  • Good comment: Disable the update command until the record needs to be saved.
  • Bad comment: Set cmd enabled = False

A good indication that you have got the level of comment right: could someone understand what your program is intended to do if all but the comments were removed?

It is a commonly expressed statement that we should have "self documenting" code but bear in mind that the code can only tell you what the code does - not why.

3. Layout code to increase legibility

Just as it is important for an author to split a book into chapters and paragraphs that aid reading so it is important for the developer to consider the layout of the code and how that can aid readability of the code. In particular, any code branch (an IF..THEN...ELSE construction) and any code repetition (a WHILE...END WHILE construction) should be indented so that it is easy to see where they start and end.

Code should be split across files (and indeed across the file system - use sub folders under your solution where that makes sense)

4. Expect the unexpected and deal with it

Before you open a file, make sure that the file is present. Before you set focus to a control, make sure that the control is visible and enabled. Try to work out what conditions could cause your code to fail and test for them before they cause the program to fall over. Also use explicit data type conversion wherever possible.

5. Name your variables and functions to aid readability

There are a number of strategies to variable naming. The key is to be consistent and to be as informative as possible. If you name a variable MonthNumber, you give the programmer extra information as to what that variable is expected to contain.  The key point is to use the name to indicate what the variable is used for.

6. Keep your functions and subroutines simple

A function or subroutine should ideally only do one thing. One of the greatest sources of misunderstandings, in my experience, is a subroutine that does a number of different operations. This should be split into separate functions for each different thing it is doing, so that these in turn are easy to reuse, and the scope of a code change is easy to understand.

7. Scope functions and variables appropriately

Functions and variables that are only used in one module should not be visible outside that module. Variables that are only used in a function or subroutine should not be visible outside that function or subroutine. This prevents any use of a variable or function outside of where it makes sense to use it.

If you declare anything as public you are responsible for how it can be used - preventing invalid data states, race conditions and so on. 

8. Test as much as possible, as soon as possible

If you an adherent of Test Driven Development you already have this but even for those not following TDD there is great value in testing as much of your code as soon as you can.  This means unit testing in the IDE before any code change is checked in and also maintaining a safety net of tests over all the existing functionality to  make sure your latest changes don't break anything. 

You should also include instrumentation or use a code profiler to see how well your application is running.  In my experience performance issues are often introduced gradually in the middle of code changes to fix other issues.

9.  Keep growing

Software development is still a young industry and best practice is still subject to change.  When a new magic silver bullet programming language or achitecture pattern comes along - give it a try with an open mind.  There is much still left to discover.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Share

About the Author

Duncan Edwards Jones
Software Developer (Senior)
Ireland Ireland
C# / SQL Server developer
Microsoft MVP 2006, 2007
Visual Basic .NET

You may also be interested in...

Comments and Discussions

 
QuestionAmen Pin
d_c_j26-Feb-15 3:33
memberd_c_j26-Feb-15 3:33 
General"The comment is the extreme example of a language element" Pin
jediYL24-Feb-15 20:14
professionaljediYL24-Feb-15 20:14 
GeneralComment often and well: another perspective Pin
WestieBoy8-Nov-14 18:02
memberWestieBoy8-Nov-14 18:02 
GeneralRe: Comment often and well: another perspective Pin
Duncan Edwards Jones21-Nov-14 19:11
professionalDuncan Edwards Jones21-Nov-14 19:11 
GeneralMy vote of 5 Pin
Edward Quixote6-Nov-14 23:17
professionalEdward Quixote6-Nov-14 23:17 
QuestionA comment very rarely be needed if the code is clean and readable.. Pin
Blake A Niemyjski6-Nov-14 12:53
memberBlake A Niemyjski6-Nov-14 12:53 
AnswerRe: A comment very rarely be needed if the code is clean and readable.. Pin
Duncan Edwards Jones6-Nov-14 20:26
professionalDuncan Edwards Jones6-Nov-14 20:26 
GeneralRe: A comment very rarely be needed if the code is clean and readable.. Pin
Steve07287-Nov-14 6:18
memberSteve07287-Nov-14 6:18 
AnswerRe: A comment very rarely be needed if the code is clean and readable.. Pin
jnlt24-Feb-15 11:50
memberjnlt24-Feb-15 11:50 
GeneralMy vote of 4 Pin
i006-Nov-14 11:37
professional i006-Nov-14 11:37 
GeneralRe: My vote of 4 Pin
Duncan Edwards Jones6-Nov-14 20:23
professionalDuncan Edwards Jones6-Nov-14 20:23 
GeneralRe: My vote of 4 Pin
i006-Nov-14 20:59
professional i006-Nov-14 20:59 
GeneralRe: My vote of 4 Pin
Duncan Edwards Jones6-Nov-14 21:51
professionalDuncan Edwards Jones6-Nov-14 21:51 
GeneralMy vote of 5 Pin
Jörgen Andersson6-Nov-14 7:07
professionalJörgen Andersson6-Nov-14 7:07 
GeneralRe: My vote of 5 Pin
Duncan Edwards Jones6-Nov-14 11:35
professionalDuncan Edwards Jones6-Nov-14 11:35 
GeneralVB6 help Pin
Anonymous1-Jul-04 8:19
sussAnonymous1-Jul-04 8:19 
GeneralRe: VB6 help Pin
Merrion22-Mar-05 6:36
memberMerrion22-Mar-05 6:36 
GeneralCode Complete Pin
edunphy1930-Oct-03 8:15
memberedunphy1930-Oct-03 8:15 
GeneralSeperate data from code Pin
twb1529-Oct-03 20:45
membertwb1529-Oct-03 20:45 
GeneralRe: Seperate data from code Pin
Duncan Edwards Jones6-Nov-14 20:28
professionalDuncan Edwards Jones6-Nov-14 20:28 
Generalsmartass remark Pin
k4_pacific29-Oct-03 3:08
memberk4_pacific29-Oct-03 3:08 
GeneralRe: smartass remark Pin
Merrion29-Oct-03 7:46
memberMerrion29-Oct-03 7:46 
GeneralType of comments Pin
garyknights22-Oct-03 4:24
membergaryknights22-Oct-03 4:24 
GeneralRe: Type of comments Pin
Kevin McFarlane27-Oct-03 23:46
memberKevin McFarlane27-Oct-03 23:46 
GeneralCosmetic ... Pin
Sébastien Lorion21-Oct-03 11:00
memberSébastien Lorion21-Oct-03 11:00 
GeneralRe: Cosmetic ... Pin
Tom Pruett22-Oct-03 4:16
memberTom Pruett22-Oct-03 4:16 
GeneralRe: Cosmetic ... Pin
Sébastien Lorion22-Oct-03 20:06
memberSébastien Lorion22-Oct-03 20:06 
GeneralRe: Cosmetic ... Pin
Tom Pruett23-Oct-03 8:07
memberTom Pruett23-Oct-03 8:07 
GeneralRe: Cosmetic ... Pin
Sébastien Lorion23-Oct-03 11:30
memberSébastien Lorion23-Oct-03 11:30 
GeneralRe: Cosmetic ... Pin
richman229-May-04 4:28
memberrichman229-May-04 4:28 
GeneralRe: Cosmetic ... Pin
Kevin McFarlane28-Oct-03 0:02
memberKevin McFarlane28-Oct-03 0:02 
GeneralRe: Cosmetic ... Pin
Kevin McFarlane27-Oct-03 23:59
memberKevin McFarlane27-Oct-03 23:59 
GeneralPoint #2 Pin
rondalescott21-Oct-03 6:58
memberrondalescott21-Oct-03 6:58 
GeneralRe: Point #2 Pin
Anonymous21-Oct-03 7:29
sussAnonymous21-Oct-03 7:29 
GeneralRe: Point #2 Pin
Michael P Butler21-Oct-03 7:41
memberMichael P Butler21-Oct-03 7:41 
GeneralRe: Point #2 Pin
Kevin McFarlane28-Oct-03 0:13
memberKevin McFarlane28-Oct-03 0:13 
GeneralRe: Point #2 Pin
danitrol28-Oct-03 20:54
memberdanitrol28-Oct-03 20:54 
GeneralRe: Point #2 Pin
Pit M.21-Oct-03 22:46
memberPit M.21-Oct-03 22:46 
GeneralRe: Point #2 Pin
Arnaud Brejeon21-Oct-03 23:41
memberArnaud Brejeon21-Oct-03 23:41 
I also quite disagree with Point #2.
Comments are very tricky because they often are not updated. I've seen many times the following happen many times.
When the code is written from sratch, the author comments very nicely. Then bugs fixing comes in the process and modifications in the code are made without updating the code (developpers hate bugs in their code and try to fix them as quickly as possible!). In the end the comments don't make sense at all.
I think this is much worse than no comment at all and frankly it happens all the time.
I believe in short functions that do a simple task and have a proper name describing precisely the task.
GeneralRe: Point #2 Pin
Kevin McFarlane28-Oct-03 0:25
memberKevin McFarlane28-Oct-03 0:25 
GeneralRe: Point #2 Pin
jhwurmbach29-Oct-03 21:14
memberjhwurmbach29-Oct-03 21:14 
GeneralRe: Point #2 Pin
Kevin McFarlane30-Oct-03 0:02
memberKevin McFarlane30-Oct-03 0:02 
GeneralRe: Point #2 Pin
jhwurmbach30-Oct-03 0:08
memberjhwurmbach30-Oct-03 0:08 
GeneralRe: Point #2 Pin
computerguru9238216-Aug-05 17:10
membercomputerguru9238216-Aug-05 17:10 
GeneralRe: Point #2 Pin
KevinHall23-Oct-03 9:14
memberKevinHall23-Oct-03 9:14 
QuestionWhat about test first ? Pin
mcarbenay4-May-03 3:28
membermcarbenay4-May-03 3:28 
AnswerRe: What about test first ? Pin
Merrion2-Oct-03 3:23
memberMerrion2-Oct-03 3:23 
GeneralAnd ... use English for comments etc. Pin
Alexander Bischofberger15-Dec-02 22:29
memberAlexander Bischofberger15-Dec-02 22:29 
GeneralRe: And ... use English for comments etc. Pin
Dieter Hammer21-Oct-03 7:09
memberDieter Hammer21-Oct-03 7:09 
GeneralRe: And ... use English for comments etc. Pin
jhwurmbach21-Oct-03 22:05
memberjhwurmbach21-Oct-03 22:05 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Terms of Use | Mobile
Web03 | 2.8.150603.1 | Last Updated 23 Feb 2015
Article Copyright 2002 by Duncan Edwards Jones
Everything else Copyright © CodeProject, 1999-2015
Layout: fixed | fluid