iOS 給函式和變數取個合適的名字

黑暗森林的歌者發表於2018-02-26

1、明確函式要做什麼   在給函式命名前,明確函式到底要做什麼。這有利於給函式命名。 2、以動詞開頭   函式總是做些什麼,所以當然要以動詞開頭。 3、儘量不要以 do 開頭   do 並不能給我們提供任何函式的資訊。相比之下,search, compute, handle 之類的動詞暗示著函式大概做了什麼。 4、返回布林值的方法以 is 或 are 開頭   用 is 還是 are 取決於判斷主體是單個還是多個。 5、合理的使用 get 作為函式名字的開頭   所有有返回值的函式,好像都可以用 get 作為函式名字的開頭。但以 get 開頭的函式應該表示取某屬性,否則就不應該用 get 開頭。比如,從伺服器上獲取使用者列表,這個方法可以叫 fetchUserList ,而不是 getUserList ;獲取某個範圍內的所有質數,可以叫 caculatePrime 。 6、不要包含上下文資訊   如有個 user 物件,有個獲取 user 的 id 的函式,應該叫 getId  而不是 getUserId 。 7、不要包含函式引數的資訊   如用一個 id 和 token 找使用者的方法,應該叫 findUser(userId, token)  而不是 findUserByUserIdAndToken(userId, token) 。如果以 findUserByUserIdAndToken  來命名,那麼如果以後函式要支援用其他方式查詢使用者怎麼辦,又或是不支援用 token 查詢怎麼辦。

相關文章