C# Coding Standards and Best Programming Practices
By
1. Author (3)
2. Licen, Copyrights and Disclaimer (3)
galaga
3. Revision History (3)
4. Introduction (3)
5. Purpo of coding standards and best practices (3)
first experience6. How to follow the standards across the team (4)
7. Naming Conventions and Standards (4)
服装店开业流程
8. Indentation and Spacing (7)
9. Good Programming practices (10)
10. Architecture (15)
11. ASP (16)
12. Comments (16)
13. Exception Handling (17)
1. Author
gundThis document is prepared by the dotnetspider team. Latest version of this document can be downloaded from /tutorials/BestPractices.aspx. Plea post your comments and feedback about this document in the above url.
Most of the information in this document is compiled from the coding standards and best practices published in various articles Also, we referred to the guidelines published by Microsoft and various other sources.
2. Licen, Copyrights and Disclaimer
You are permitted to u and distribute this document for any non commercial purpo as long as you retain this licen & copyrights information.
This document is provided on “As-Is” basis. The author of this document will not be responsible for any kind of loss for you due to any inaccurate information provided in this document.
厦大考试中心3. Revision History
If you are editing this document, you are required to fill the revision history with your name and time stamp so that anybody can easily distinguish your updates from the original author.
4. Introduction广外雅思
Anybody can write code. With a few months of programming experience, you can write 'working applications'. Making it work is easy, but doing it the right way requires more work, than just making it work.
Believe it, majority of the programmers write 'working code', but not …good code'. Writing 'good code' is an art and you must learn and practice it.
Every one may have different definitions for the term …good c ode‟. In my definition, the following are the characteristics of good code.
english song
∙Reliable
∙Maintainable
∙Efficient
Most of the developers are inclined towards writing code for higher performance, compromising reliability and maintainability. But considering the long term ROI (Return On Investment), efficiency and performance comes below reliability and maintainability. If your code is not reliable and maintainable, you (and your company) will be spending lot of time to identify issues, trying to understand code etc throughout the life of your application.
5. Purpo of coding standards and best practices
dual coreTo develop reliable and maintainable applications, you must follow coding standards and best practices. The naming conventions, coding standards and best practices described in this document are compiled from our own experience and by referring to various Microsoft and non Microsoft guidelines.
There are veral standards exists in the programming industry. None of them are wrong or bad and you may follow any of them. What is more important is, lecting one standard approach and ensuring that everyone is following it.
6. How to follow the standards across the team
If you have a team of different skills and tastes, you are going to have a tough time convincing everyone to follow the same standards. The best approach is to have a team meeting and developing your own standards document. You may u this document as a template to prepare your own document.
Distribute a copy of this document (or your own coding standard document) well ahead of the coding standards meeting. All members should come to the meeting prepared to discuss pros and cons of the various points in the document. Make sure you have a manager prent in the meeting to resolv
e conflicts.
Discuss all points in the document. Everyone may have a different opinion about each point, but at the end of the discussion, all members must agree upon the standard you are going to follow. Prepare a new standards document with appropriate changes bad on the suggestions from all of the team members. Print copies of it and post it in all workstations.
After you start the development, you must schedule code review meetings to ensure that everyone is following the rules. 3 types of code reviews are recommended:
1. Peer review – another team member review the code to ensure that the code follows the
coding standards and meets requirements. This level of review can include some unit
testing also. Every file in the project must go through this process.
2. Architect review – the architect of the team must review the core modules of the project
to ensure that they adhere to the design and there is no “big” mistakes that can affect the project in the long run.
3. Group review – randomly lect one or more files and conduct a group review once in a
week. Distribute a printed copy of the files to all team members 30 minutes before the
meeting. Let them read and come up with points for discussion. In the group review
女阴
meeting, u a projector to display the file content in the screen. Go through every
ctions of the code and let every member give their suggestions on how could that piece of code can be written in a better way. (Don‟t forget to appreciate the developer for the
good work and also make sure he does not get offended by the “group attack”!)
7. Naming Conventions and Standards
1. U s e P a s c a l c a s i n g f o r C l a s s n a m e s
p u b l i c c l a s s H e l l o W o r l d
{
...
}
2. U s e P a s c a l c a s i n g f o r M e t h o d n a m e s
v o i d S a y H e l l o(s t r i n g n a m e)
{
...
}
3. U s e C a m e l c a s i n g f o r v a r i a b l e s a n d m e t h o d p a r a m e t e r s
i n t t o t a l C o u n t=0;
v o i d S a y H e l l o(s t r i n g n a m e)
{
s t r i n g f u l l M e s s a g e="H e l l o"+n a m e;
...
}东莞成人教育
4. U s e t h e p r e f i x“I”w i t h C a m e l C a s i n g f o r i n t e r f a c e s(E x a m p l e:I E n t i t y)
5. D o n o t u s e H u n g a r i a n n o t a t i o n t o n a m e v a r i a b l e s.
I n e a r l i e r d a y s m o s t o f t h e p r o g r a m m e r s l i k e d i t-h a v i n g t h e d a t a t y p e a s
a p r e f i x f o r t h e v a r i a b l e n a m e a n d u s i n g m_a s p r e f i x f o r m e m b e r v a r i a b l e s.E g:
s t r i n g m_s N a m e;
i n t n A g e;
H o w e v e r,i n.N E T c o d i n g s t a n d a r d s,t h i s i s n o t r e c o m m e n d e d.U s a g e o f d a t a t y p e a n d m_t o r e p r e s e n t
m e m b e r v a r i a b l e s s h o u l d n o t b e u s e d.A l l v a r i a b l e s s h o u l d u s e c a m e l c a s i n g.
6. U s e M e a n i n g f u l,d e s c r i p t i v e w o r d s t o n a m e v a r i a b l e s.D o n o t u s e a b b r e v i a t i o n s.
G o o d:
s t r i n g a d d r e s s
i n t s a l a r y
N o t G o o d:
s t r i n g n a m
s t r i n g a d d r
