為什麼公開的一些代碼的注釋真的好少,沒有注釋我們這些新手好難玩?
我就不一一截圖了,我覺得你們這些大牛公開一些代碼基本沒什麼注釋,是速度太快了么?特別是一些在網上寫教程的,我感覺會浪費我們這些新手很多時間。
更新。看了大神們的答案。確實是我不對。抱歉。我那句話大家別誤解,我的意思並不是不尊重你們,我的意思大概是說,我不知道如何找入口。就是一個項目我不知道如何找入口,,不知道重哪裡下手。或者說我跟著那些代碼敲著敲著思路就不清晰了。或者說敲著敲著就就感覺和吵作文一樣的了。我不是很會組織語言,謝謝大家的提醒,下次一定會組織好語言在提問,同時對那些邀請或沒邀請的大神說句,對不起。我只是一個善意的提問。抱歉。同時我也想問問大神們剛開始學別人項目是如何清晰的吃透別人的代碼的?有什麼好的方法沒?或者求個鏈接。謝謝。
對於新人來說,缺少的不是注釋,而是big picture。
新手的時間,也是時間了么,你貼個圖都懶。。。
你覺得看不懂,要求弄成你的水平,然而還有比你更低的,要不要按他們的標準來?你會不會嫌棄啰嗦?會不會說『我覺得我都能看懂那大部分人也就夠了』
看不懂,就換一個,找更低級的讀物除非對問題上下文有所理解,不然,讀陌生程序的入口通常不是代碼,而是一篇提綱挈領的README.md,或者一個清晰易懂的文件組織結構,沒有對全局關鍵概念的理解,代碼局部里注釋再多,你也發現不了它的意義。README.md是顯式的文檔,目錄與文件結構是一種隱式的文檔,讀懂這兩個再來看局部代碼,會容易得多。
另外,不能假設大牛寫的一定是值得讀的代碼,好代碼並不取決於一個人的聲望,更多時候是一段較長時間的雕琢,就像好文章一樣,好代碼也是反覆修改出來的。經過幾年迭代的項目更值得讀,特別是你每天用到的庫和工具,因為時間充分,這些項目的局部注釋都規範嚴謹,README.md和目錄文件結構也不會少。你一行一行讓我們寫注釋我們也好難玩,自己去猜啊
個人意見:1,注釋大多是給自己看的,以供修改時快速了解代碼塊的功能作用,或者代碼規範里某些生僻的點。2,命名規範了,就不大需要注釋,大部分的注釋均產生在臨時加急的修修補補的過程中。3,團隊協作時會需要寫某些注釋,意義同1,大部分為業務功能性的注釋。4,代碼只要能debug進去,功能邏輯就能一一理順,所以你的看不懂,是在某些知識點上?
5,知識點方面,於你成長而言,百看不如一練。在代碼中於我而言,不會浪費時間去給通用性的語句寫注釋。
比如這種:var a = true? {"red":"1","yellow":"2"} ["red"] ||"":"black";
沒啥好注釋,但是你可能會看不懂,於是跑來知乎發帖,然而這對你的代碼研讀毫無作用。
至於我是為什麼能知道這樣寫的,多讀書多看報,少吃零食多睡覺,反正不是在這裡提問學會的。6,有人習慣寫注釋,有人不習慣,努力提升自己的水平才是王道。而單純的看代碼,並不能對提高有多大幫助,看著寫,學著寫,不明白的點就去問,在過程中體會每一個操作的意義,才是提升的最佳途徑。7,看不懂的教程,別硬看,從看得懂的開始看。有兩種人的時間是不值錢的:初學者 和 窮人。
公開代碼不是用來給新手看的。是用來給想給這個軟體增加刪除修改功能,調試錯誤的同行程序員看的。
公開課,才是給新手看的。不會讓新手覺得難玩。程序員何必為難程序員!寫注釋是利他行為,儘管自己也可以看。那麼問題來了,大牛們當年也是看的沒注釋的代碼,現在憑什麼讓他們寫注釋給後人看。
遇到這種情況只有一種可能。這個項目的難度與技術遠遠超過你的技術認知範圍。所以,腳踏實地的來吧。
另外,看真實代碼學習的意義不大。除非是已經入門這個領域並且對領域知識有一定掌握,否則,只能自嗨。共勉
顯然寫注釋很費時間。
更顯然新手的時間相對大牛的時間,簡直一文不值.業務邏輯可以加上點注釋,比如1幹什麼, 2幹什麼,3幹什麼。但是一些演算法比如一個循環 一個遞歸什麼的,加不加註釋都一樣了,看得懂的人一眼看懂,看不懂的人有注釋也看不懂。
代碼即注釋。
入職第一天,boss一句話印象深刻:咱能用代碼說清楚的別用注釋,這句注釋誰能給我寫個代碼解釋一下……
給你寫教程,不感謝人家,還指責浪費你時間。。臉皮厚的可以。。
首先明白一個概念,注釋是描述代碼概要邏輯的,讓別人明白代碼意思!編程需要追求的目標是像人類說話語言一樣,命令計算機工作的!兩者某種意義上追求的目標是一致的,只不過一個對象是人,一個對象是機器!那麼我們代碼可不可以寫的很漂亮,像在跟機器說話一樣,人和機器都明白!一方面語言的語法需要努力,每個語言都在想這個方向進步,另一方面程序員編寫代碼,能不能命名規範,有意義,像說話一樣編寫代碼!
這樣代碼即注釋,注釋即代碼!
語言本身就不說了,對於程序員就說,這就是代碼風格,就是自身修養要追求的方向!如果你在寫代碼時注意了該問題,你的代碼自然很漂亮,很少需要注釋了!也不會糾結這個問題了!與君共勉,該路無止境啊!你還是截圖出來吧,讓大家看看是什麼代碼你看不懂。
代碼即注釋...
一般只有寫得比較丑的代碼才會專門加註釋,因為怕你看不懂;不加的都是「我寫得這麼優雅,看不懂的一定是外行」。
當然esdoc那種例行公事的注釋應該視為文檔。程序員最恨別人寫的代碼沒注釋沒文檔,程序員最討厭自己寫代碼時寫注釋寫文檔...
推薦閱讀:
※中國人為什麼不聯合起來揭露印度IT consulting firm為員工簡歷造假的行為?
※微軟開源了 Core CLR,作為 .NET 開發人員,是否需要花精力去研究Core CLR 源代碼?為什麼?
※銀行櫃員三年,轉行做房產中介還是程序員?
※你目前寫出的最大的 Bug 是怎樣的?
※如何看待仙海總裁張旭因過度勞累突然離世?