`寫一篇文章氮采,要層次清楚,段落分明染苛,寫代碼也是這樣鹊漠。雜志排版主到,布局合理,閱讀舒服躯概,代碼的編排也很重要`
代碼整潔的優(yōu)點(diǎn)
代碼的整理并不復(fù)雜登钥,也不需要什么高深的技巧。有效的使用代碼娶靡,空格和縮進(jìn)牧牢,簡(jiǎn)單的分割與對(duì)齊,就可以使得代碼的視覺(jué)效果甚至質(zhì)量發(fā)生巨大的變化姿锭,
理順編碼的思路塔鳍,提高編碼的效率。這是一個(gè)付出少呻此,收獲大轮纫,值得養(yǎng)成的好習(xí)慣。
解決方案:給代碼分塊
reason:
我們的大腦接收信息是按照分塊的模式進(jìn)行的焚鲜。一塊是一個(gè)可識(shí)別的信息蜡感,它被安放到短期的記憶的"插槽"里。
信息塊的實(shí)際信息量是可變的恃泪,但是越簡(jiǎn)單郑兴,越具體的信息塊越容易被記住和理解。
一個(gè)代碼文件贝乎,可以看做是一個(gè)雜志版面情连,在這個(gè)版面里,我們要把代碼整理成清晰的模塊览效,這樣的每一塊在視覺(jué)上和邏輯上都是可以區(qū)分的却舀,
可以幫助我們閱讀和記憶,減輕眼睛和大腦的疲勞锤灿。
`優(yōu)化一:`
例子1:下面的兩種形式的語(yǔ)句挽拔。這兩種形式,在實(shí)際邏輯上是完全相同的但校。但是螃诅,第二個(gè)語(yǔ)句使用了
更細(xì)化的塊,這樣視覺(jué)形式和邏輯形式都是清晰直觀的状囱。
1.
if(firstName !=null && lastName != null)
2.
if((firstName!=null)&&(lastName != null));
如果一段代碼放眼望去都是大塊大塊的术裸,那對(duì)于一個(gè)初學(xué)者來(lái)說(shuō),閱讀和理解就非常困難亭枷。
他需要將復(fù)雜的表達(dá)式再次分解袭艺,分解到可以單獨(dú)理解的變量和運(yùn)算符,再重新組合叨粘。
**_注意三點(diǎn):_**
1.保持代碼塊的單一性猾编,一個(gè)代碼塊只能有一個(gè)目標(biāo)瘤睹。
代碼塊內(nèi)的所有的內(nèi)容都是為了一個(gè)目標(biāo)服務(wù)的,不能把無(wú)關(guān)的內(nèi)容放在同一個(gè)代碼塊里答倡。同一個(gè)代碼塊里的
語(yǔ)句相互聯(lián)系比與相鄰代碼塊里的語(yǔ)句更為緊密默蚌。
2.注意代碼塊的完整性
代碼塊就是一個(gè)完整的信息塊。一個(gè)代碼塊要表達(dá)一個(gè)相對(duì)完整的意思苇羡,不能一個(gè)意思沒(méi)說(shuō)完就分塊了绸吸。
3,代碼塊數(shù)量要適當(dāng)
一個(gè)基礎(chǔ)的代碼塊最好不要超過(guò)25行设江,否則就會(huì)有增加閱讀的理解的困難锦茁。
**使用空白空間**
? 為什么呢?
靠近的代碼會(huì)形成一個(gè)視覺(jué)塊叉存,并且具有隱含的關(guān)聯(lián)码俩。分開(kāi)的代碼,意味著上下代碼的關(guān)聯(lián)沒(méi)有那么緊密歼捏。這種視覺(jué)
效果會(huì)給我們暗示稿存,代碼直接的關(guān)系越緊密。
因此瞳秽,空白區(qū)域瓣履,不僅僅可以用來(lái)分割代碼,還展示了代碼之間的關(guān)系练俐。
**一行一個(gè)行為**
每一行代碼僅僅表示一個(gè)行為袖迎。這樣的每一行代碼才是常規(guī)的大小的,可以識(shí)別的基礎(chǔ)信息塊腺晾。
下面這行代碼包含了兩個(gè)行為燕锥,一個(gè)是判斷行為,一個(gè)是執(zhí)行行為悯蝉。兩個(gè)行為放在一行归形,這樣的代碼不僅看起來(lái)有些亂,
我們的大腦處理起來(lái)有些萌鼻由。
`if (variable != null) variable.doSomething();`
如果分割開(kāi)這兩個(gè)行為暇榴,信息塊的區(qū)隔會(huì)更明顯,代碼會(huì)更清晰嗡靡。
if (variable != null) {
variable.doSomething();
}
一般一個(gè)完整的表達(dá)式可以看做是一個(gè)完整的獨(dú)立行為跺撼。
**基本的換行原則**
代碼分塊的基本思想窟感,同樣使用與換行讨彼。基本的換行需要考略一下三點(diǎn)柿祈。
1哈误。每行代碼字符數(shù)的限制哩至。
2。如果一行不足以容納一個(gè)表達(dá)式蜜自,就需要換行菩貌;
3。一般的換行原則包括一下5點(diǎn)
1.在逗號(hào)后換行
String variable = anObject.getSomething(longExpressionOne,
longExpressionTwo, longExpressionThree);
2重荠。在操作符前換行
String varibale = longStringOne + longStringTwo
+ longStringThree;
3箭阶。高級(jí)別的換行優(yōu)先
anObject.methodOne(parameterForMethodOne,
anObject.methodTwo(parameterForMethodTwo));
/ conventional indentation
int runningMiles = runningSpeedOne * runningTimeOne
+ runningSpeedTwo * runningTimeTwo;
// confusing indentation
int runningMiles = runningSpeedOne
* runningTimeOne + runningSpeedTwo
* runningTimeTwo;
4。新的換行與上一行同級(jí)別表達(dá)式的開(kāi)頭對(duì)齊
anObject.methodOne(parameterOne,
parameterTwo,
parameterTwo);
5戈鲁。如果上述規(guī)則導(dǎo)致代碼混亂或者代碼太靠右仇参,使用8個(gè)空格作為鎖進(jìn)
anObject.methodOne(parameterForMethodOne,
anObject.methodTwo(parameterOneForMethodTwo,
parameterTwoForMethodTwo,
parameterThreeForMethodTwo));
// bad indentation
if ((conditionOne && conditionTwo)
|| (conditionThree && conditionFour)) {
doSomething();
}
// a better indentation, using 8 spaces for the indentation
if ((conditionOne && conditionTwo)
|| (conditionThree && conditionFour)) {
doSomething();
}
import java.util.HashMap;
import java.util.Map;
class Solution {
/**
* Given an array of integers, return indices of the two numbers
* such that they add up to a specific target.
*/
public int[] twoSum(int[] nums, int target) {
Map map = new HashMap<>();
for (int i = 0; i < nums.length; i++) {
int complement = target - nums[i];
if (map.containsKey(complement)) {
return new int[] { map.get(complement), i };
}
map.put(nums[i], i);
}
throw new IllegalArgumentException("No two sum solution");
? }
}