Closed twy30 closed 3 years ago
我有時候也會遇到這種情況,會覺得ipAddress跟address比起來,ipAddress有重複上下文的感覺(因為function name已有或class name有), 不知道對於這種情況有沒有什麼衡量、判斷的方法?
@adks3489
我有時候也會遇到這種情況,會覺得ipAddress跟address比起來,ipAddress有重複上下文的感覺(因為function name已有或class name有), 不知道對於這種情況有沒有什麼衡量、判斷的方法?
我還沒有很完整的想法,以下是我想到的兩個方向:
以這個案例來說,在 address
前面加 ip
, 最後形成的 ipAddress
仍然只有 1 種讀法,整個字也不至於「太長」,所以我會覺得「加上 ip
」是正面大於負面。
有的時候,加字會變成 3 個字,例如 storeManagerName
, 這時候有 2 種讀法: storeManager
+ Name
或 store
+ ManagerName
,還算可以接受,但整個字就覺得「有點長」。
有的時候,加字會變成 4 個字,那就會有 n 種讀法,變得很複雜,整個字多半也會太長,這樣子的「加字」大概就會是負面多於正面。
在這個案例來說,的確可以從 address
就知道它是指 "IP address", 但如果程式碼再長一點,無法一次裝進人腦工作記憶區的話,或許 ipAddress
會比較好。
再麻煩大大給予命名上的建議 orz
(註解的部分,猶豫很久後決定不放上來。程式碼很簡單,放註解應該會浪費大大們的時間 XD )
總之,非常感謝 orz
public string DefangIPaddr(string inputIPAddress)
{
string[] IPNumbersArray = inputIPAddress.Split(".");
string defangedIPAddress = IPNumbersArray[0];
for (int i = 1; i < IPNumbersArray.Length; ++i)
{
defangedIPAddress +=$"[.]{IPNumbersArray[i]}";
}
return defangedIPAddress;
}
@LPenny-github
(註解的部分,猶豫很久後決定不放上來。程式碼很簡單,放註解應該會浪費大大們的時間 XD )
談到「註解」,有興趣的話可以參考這篇文章: https://github.com/EngTW/English-for-Programmers/blob/master/notes/2018-12-30-commenting.md 😊
public string DefangIPaddr(string inputIPAddress)
這裡的語意我覺得沒問題,但這裡有個很有趣的「語法」案例: IP
的大小寫。
input
, IP
, Address
三個字,我會選擇寫成 inputIpAddress
Microsoft.VisualBasic.FileIO
( https://docs.microsoft.com/en-us/dotnet/api/microsoft.visualbasic.fileio?view=net-5.0 )UICancelOption
( https://docs.microsoft.com/en-us/dotnet/api/microsoft.visualbasic.fileio.uicanceloption?view=net-5.0 )UIOption
( https://docs.microsoft.com/en-us/dotnet/api/microsoft.visualbasic.fileio.uioption?view=net-5.0 )System.IO
( https://docs.microsoft.com/en-us/dotnet/api/system.io?view=net-5.0 )System.Windows.Media.Media3D
的 3D
( https://docs.microsoft.com/en-us/dotnet/api/system.windows.media.media3d?view=net-5.0 )UIOption
) 、字尾 ( FileIO
)、或獨立存在 ( System.IO
)
string[] IPNumbersArray = inputIPAddress.Split(".");
ipNumberTokens
( https://en.wikipedia.org/wiki/Lexical_analysis#Token )@twy30 非常感謝大大的指教 orz
...
- 沒看到像這裡這樣『該「兩個字母的縮寫」是在字中間』的情形的例子 🤔
找到啦!
ContainerUIElement3D
(https://docs.microsoft.com/en-us/dotnet/api/system.windows.media.media3d.containeruielement3d?view=net-5.0)
@lddr99 十分感謝提供資料 😊
https://leetcode.com/problems/defanging-an-ip-address/
請參考「刷 LeetCode 練習命名」 https://github.com/EngTW/English-for-Programmers/issues/69 😊