【原】代碼的整潔不只是給別人看的，更多的是給自己看！

東北十三少 2021-09-01

展開全文

作為一個(gè)程序員，如果你看到下面這段Java代碼，你能有興趣把這段不到30行的代碼看完，看懂這段代碼完成什么功能嗎？

public class BP {
    public void cvt(File i, File o) {
    BufferedReader r=null;
    BufferedWriter w;
    String l, j="[";
    String[] p;
    try {
    r=new BufferedReader(new FileReader(i));
    } catch (FileNotFoundException e) {}
    try{
    while ((l=r.readLine())! =null){
    p=l.split(", ");
    if(! p[3].equals("fiction")&&! p[3].equals("nonfiction"))continue;
    j+="{";
    j+="title:\""+p[0]+"\", ";
    j+="author:\""+p[1]+"\", ";
    j+="pages:\""+Integer.parseInt(p[2])+"\", ";
    j+="category:\""+p[3]+"\"";
    j+="}, ";
    }
    try {
    r.close();
    } catch(IOException e) {}
    } catch(IOException e) {}
    j+="]";
    try {
    w=new BufferedWriter(new FileWriter(o));
    w.write(j);
    w.close();
    } catch (IOException e) {}}}

實(shí)際上，大多數(shù)人只會掃了一眼代碼就立即放棄了。因?yàn)樗鼘δ銦o關(guān)緊要，更因?yàn)樗粔蛘麧?，可讀性差。

作為一個(gè)程序員，你開發(fā)的代碼或多或少都會被要求代碼的編寫要注重可讀性。比如，在各種開發(fā)語言的編碼規(guī)范中都會有注釋和注釋率的要求，都會有變量命名的要求，以及布局、縮進(jìn)等格式和排版的要求。這些要求都是為了增加代碼的可讀性。

因?yàn)榇a是給人閱讀的。

但是，這里一直有個(gè)誤區(qū)。

程序員往往覺得可讀性是對別人來說的，組織要求代碼具備可讀性是為了軟件維護(hù)的需要。如果代碼不具備可讀性，維護(hù)人員面對著一段沒有注釋，變量名毫無意義的代碼，會如同看一本天書，那對于維護(hù)人員就是一場災(zāi)難?？墒?，這并不意味著代碼可讀性對于開發(fā)人員自己就不重要。正相反，讓代碼具備可讀性，首先得到好處的就是編寫這段代碼的程序員自己。

下圖是一個(gè)程序員每天工作時(shí)間上的分配：

程序員一天的工作時(shí)間中只有不到50%的時(shí)間是花在編程任務(wù)上的。而在編程的時(shí)間里面，閱讀代碼和編寫代碼的時(shí)間比大大超過了10∶1，而實(shí)際花在編寫代碼的極少部分的時(shí)間中，80%以上的時(shí)間又是在修改或修復(fù)已有的代碼。如果一天工作8小時(shí)，能有5分鐘花在編寫新代碼上就已經(jīng)不錯(cuò)了。這個(gè)結(jié)果表明，程序員的工作時(shí)間主要不是用于編寫代碼，而是在理解代碼。

所以，如果程序員編寫的代碼易于理解，可讀性好，那就意味著他可以節(jié)省很多理解代碼的時(shí)間，他的工作效率會極大地提高。

作為一個(gè)程序員，編寫整潔的代碼，不是為了別人，更多的是為了你自己！

這正是：

代碼整潔易理解，開發(fā)維護(hù)皆受益

代碼不只給人看，更多還是為自己

參考書目：奔跑吧，程序員：從零開始打造產(chǎn)品、技術(shù)和團(tuán)隊(duì)，作者：[美]葉夫根尼·布里克曼，譯者：吳曉嘉，出版社：人民郵電出版社