好的介面容易被正確使用,不易被誤用 考慮以下函數: void func(int year,int month,int day){ //一些操作 } 這個函數看似合理,因為參數的名字已經暴露了它的用途。但是如果只有寒暑簽名呢?如下: void func(int,int,int); 就算我告訴你,此處需... ...
好的介面容易被正確使用,不易被誤用
考慮以下函數:
void func(int year,int month,int day){
//一些操作
}
這個函數看似合理,因為參數的名字已經暴露了它的用途。但是如果只有寒暑簽名呢?如下:
void func(int,int,int);
就算我告訴你,此處需要日期作為參數,你可能會以月日年、日月年等不同形式作為參數。
正確的做法是把年月日都各自抽象為一個類(或者說是結構體):
struct Year {
int year;
};
struct Month {
int month;
};
struct Day {
int day;
};
void func(Year year,Month month,Day day){
//一些操作
}
這樣即使你只有函數簽名,也不會輕易出錯。
用於內置類型的行為相容
儘量要在行為上與現有類型相容,因為一般用戶會先與類型作為參考。
如:int類型不支持:
int a=5;
int b=6;
int c=50;
a+b=c;//錯誤
那麼你自己定義的類型,也不應該有類似的語法:
MyType a;
MyType b;
MyType c;
a+b=c;//儘量不要這樣去做,除非你有更好的理由
建立新類型、限制類型上的操作、束縛對象值、消除客戶的資源管理責任
為了防止用戶犯錯,一般的方式就是為我們的新類型加上各種限制,比如限定月份的值為1到12,日期的值為1到31等。在用戶輸入非法的值的時候給出明確的提示或警告。
設想各種被應用的場景
我們要假設用戶各種可能犯錯的場景,比如,在多線程環境中使用,如果不支持多線程,就應該明確的在文檔中輸出。或者是,用戶的非法輸入,非法調用,我們應該儘可能地進行合法性檢驗。
儘可能讓用戶在不改變現有使用習慣的情況下,儘可能的少出錯。