對程式員而言,我們的代碼需要:
1. 在預算内實作需求,讓使用者可以使用 -- 讓自己或者公司可以賺到錢
2. 友善自己修改及日後維護
3. 友善别人修改及日後維護
4. 便于重複使用,為以後的開發節省時間
5. 讓系統高效的運作
從美國商學院畢業的學生們掌握了很多相似的思維模式,這不僅有利于他們解決問題,更重要的是友善他們彼此之間溝通。-- 換句話說,他們畢業後都安裝上了相同的協定和一些可通用的接口,這樣有一個基礎平台可以讓他們協同工作。
也許有人認為沒有必要再提這個問題,但在日常編碼生活中,這的确是一個很重要的話題。
7.1 類名、方法、常數使用Pascal casing
public class MyClass
{
const int DefaultNumber = 100;
public void MyMethod()
{ }
}
7.2 局部變量,參數用camel casing
partial void OnContactIdChanging(int value)
int number;
7.3 interface 名字以I 開頭
7.4 盡量不用單個字元命名變量,象 i 或者 t 。使用 index 或者 temp 之類代替。
7.5 将所有來自framework 的 namespace 放在前面,而後再放第三方或自定義的:
using System;
using System.Linq;
using System.Data.Linq;
using System.Collections.Generic;
using System.Text;
using System.ComponentModel.DataAnnotations;
using CodeSmith.Data.Attributes;
using CodeSmith.Data.Rules;
一些說明:不是為了給自己一個緊箍咒,而是在日常程式設計中,我們發現如果你寫的方法不滿足這樣一個條件,一年後,就算是你自己也不太想去維護和修改,如果換成是其他程式員會對此更加的頭痛,對嗎?
僅在必要的時候注釋你的代碼,不要太多,并且注釋也要簡單給力。
正确的:
string name = string.Empty;
不建議:
string name = "";
觀察下面這段可愛的代碼:
public bool Equals(CommentData obj) {
if (!CommentId.Equals(obj.CommentId)) return false;
if (!Comment.Equals(obj.Comment)) return false;
if (!CommentorId.Equals(obj.CommentorId)) return false;
return true;
如果我們寫成這樣會不會好些呢:
return CommentId == obj.CommentId &&
Comment.Equals(obj.Comment) &&
CommentorId == obj.CommentorId;
當有新的需求或新改動的時候,可以撥一些時間來重構。 -- 你可能突然發現,原來重構後的代碼可以如此美麗。使用一些重構的插件,比如resharper可以使你事半功倍。
未完待繼…