返回列表 上一主題 發帖

關於 請養成良好的寫程式習慣 結帖

請養成良好的寫程式習慣

本帖最後由 white5168 於 2012-5-8 10:16 編輯

我在這裡提出個人在最近觀察後的建言,如有不中意聽或有得罪的話請個位大大多多包涵,無非也希望讓這個討論區好

我覺得不管是寫得多少年程式或是版主,超級版主等等,都應該有必要在程式是中加上應有說明與良好的習慣才是
剛開始投身於程式工程師時也是跌跌撞撞,從一個只會胡亂命名,甚至只會將所有功能寫在同一個函數中的毛頭小子
慢慢變成會要求下屬寫程式要有模組化函數名稱與變數名稱要定義為有意義的名字
並且告誡他們寫程式不是寫給自己看的爽就好,也要能讓後面維護程式碼的人可以快速了解當初寫程式的想法及思路
至於要在程式中加入註解,剛開始也是很不能適應為何一定要在程式裡加上說明,但久而久之習慣了,沒加反而不習慣
因為哪一天自己需要再回過頭來看的時候,就可以很快就能回憶上手,才不會再花時間去回想當初的想法

各位寫小程式時可能比較沒有感覺,可是像我們在寫大型程式,一次都幾百萬行在看的時候,加上註解與明確的定義就真的很重要
因為一旦要debug時,真的會很想死,尤其是像這樣幾百萬行的程式通常不會只有一個人寫,一定是4~5個人以上甚至更多人寫,如果加上每個人風格都不同時那更是痛苦萬分
所以文字的表達就更顯重要,若是函數,變數,註解與log沒有加完整甚至不明確的話,那這樣更是會想打人,光是看那幾百萬行的程式碼時,眼睛就會有那種"脫窗"的感覺

因此在此誠心的建議各版版主們應該好好思考一下,各討論版在程式碼上的是否應該要求版友們在寫程式的習慣,以讓此討論區越來越更有看頭與成長茁壯
不過我相信版主們會認為,要要求版友做到這樣實在有困難,可是如果現在有些事不做以後會更困難更後悔
"不要為失敗找藉口,要為成功找方法",這是很多人說過的話

個人的建議,
對於寫程式已久的人,是否應該思考的該如何寫得讓人家看得懂的程式,而非寫給自己看的爽的程式,
對於剛開始接觸新程式語言的新人,更應該學習養成良好的寫程式習慣,這樣哪天回頭來複習的時候可以更清楚當初的思路
要將程式碼貼上的同時,請先了解完整個思路,有的程式碼是網路上搜尋找到貼上的,真的很希望各位版友在放置程式碼的同時也應該去理解他,不要淪為只會做複製貼上的大學生

模組化:將有意義的功能包成一個個明確且可重複使用的函數,以建立屬於"麻辣家族討論版版"的函數庫,如建立Library
我覺得在"麻辣家族討論版版"中有很多不錯使用且具重複性的資源可以整合成讓使用者使用的Library,只是在想為什麼版主沒有這樣的觀念及想法

函數與變數的命名:我看了很多人回應的程式碼,甚至各個討論版得版主所回應的程式碼,在程式碼中很多的變數常常寫x, y, k等等,不具任何意義名稱的變數
而在工作上我會要求下屬們,函數命名一定要式一個動詞接一定名詞,如取得股票股價,命名的函數就會是GetStockPrice()或ReadStockPrice()

說了這麼多,無非也是希望各位大大們能了解,不管是寫了程式多少年,沒有一個好的習慣養成,這樣程式的可讀性真的很低
為了這個討論區好請各位大大認真思考以上所說的內容
以上的言論如有冒犯的地方請多多包涵

TOP

如果像版大所說的
那建議從版主做起.彼此在相互監督

TOP

關於 請養成良好的寫程式習慣 結帖

感謝版主的指教,我認同版主所說部分的內容,畢竟一個政策的執行不能只是單看單一個案,而去否決他人所提的意見,更重要的要多去了解大眾想求知的慾望,
就像小孩子,從小就要教他尊重他人所說的話與意見,而不是一昧教他要先去否決他人,這樣未來他長大的同時,將會變成一個不管任他人有任何意見就只會否決的人
寫程式是否要加註解端看個人,畢竟有人想學有人不想學,想學的人想要知道更多的話,就應該有讓他有知的權利,版主應該將思維放在如何提升討論版的素質上,而非去評斷他人所發表的文章內容是否有價值
畢竟就是因為有必要才會發表出來,如果每個人都是認為有價值的才發表,沒價值得就應該結帖的話,那真的是阻礙進步與成長的元兇
一個實驗成不成功,不能只端看實驗結果,如果有好的結果就表示成功的話,那這樣錯誤不就不會發生了,可是科學是靠每一次不斷的失敗與努力才有的結果,從失敗中記取教訓,所以失敗也是一個好的成功實驗,如果只單看一個案例是不準確
建議版主應該想遠一點,而非只限於此眼前的評論
我們不能祈求每個人都一定要去實踐,但我們能做的是如何努力去改變大家寫程式的習慣與矯正風氣,而不是一昧的打擊
我相信每個人的出法點都是好的(當然以包括每位版主),如果以上的說法令各位不舒服,再請各位多多包涵,我並非要引起爭論只想請版主多思考,畢竟大家都是正面的出發點,不應該就此結帖

        靜思自在 : 口說好話、心想好意、身行好事。
返回列表 上一主題