Re: [討論] 什麼情況下該把task包成function

[yauhh (喲)]

※ 引述《BM0108 (衝)》之銘言：
: 在「同一份file」中（不同file間要import，那當然要把task包成function，毫無疑問）
: 假如某個task過於龐大或是要被重複使用，那都可以包成一個function以利維護及使用
: 這是我的認知
: 最近聽到一個說法是
: 為了日後maintain方便，
: 即便只有3,4行code且只會用到一次的小task也應該被寫成一個function
: 乍聽之下頗有道理
: 可是我自己的經驗是
: 過份的把task包成function
: 整分file的行數會激增還是小事，
: 日後要maintain時，會需要一直回頭查某個function的實做方式
: 就算註解或doc寫得很好，查註解或doc畢竟不如直接看code來得直接
: 更何況，絕大多數的情況下，註解都寫得很簡陋、通常不會有doc這種東西 Orz
: 想和版上前輩請益一下，究竟是我沒掌握到精髓
: 還是過小、使用頻率不高的task，確實不需要包成function？

"即使只有3,4行code且只會用到一次的小task也應該被寫成一個function"
這句話,我們可以檢查這句話套用到多少種情況中.

有人說,所謂模組化程式設計,就是每隔100行程式劃一條紅線.
事實上是這樣子嗎? 就算這樣劃一劃,也不會幫助你好好整理程式.

有人說低藕合,高內聚,ok,這一點很重要.

有人說物件導向... 分一分各種函數到各種模組及類別中之後,
我們經常可以回頭仔細一想,然後說其實自己並沒有使用物件導向思考.
(物件導向並不是先寫一個物件,然後後面加一個點帶出它的方法或屬性,就算數.
 或許你寫一堆OOP的程式,但工夫做得最好的是把函數整理得很好.)

那麼,最起碼,好好地整理一些函數呢? 什麼叫作函數,是把共用的程式碼收在一起
就稱為函數嗎?

個人覺得,從英文字面來思考,所謂函數 function, 另一個意思就是功能.
一個函數是充份發揮一個功能的單元,特別是你關心這個函數呼叫之後拿到的傳回值.
可是我們又知道,程式纏在一起的時候,很多函數都會稱為副程式,而且是
在基本的輸入和輸出值之外,還被一大堆前置狀態纏住.

我個人覺得,起碼你可以把函數和副程式二樣東西區分清楚.
如果你要寫一個函數,那就以輸入值和輸出值為重.
如果你要寫副程式,也就是將幾行共用的程式碼收在一個地方,那麼狀態的一致性
就是低藕合的重點. 你最好將每一個副程式的進入狀態分析清楚,比較好掌握.

我覺得劃分各種程式區塊,無論是函數,副程式或任何長段程式的子段落,
你都要給這個程式區塊定義一項明確的定義.
這定義就好像是命名一樣,抓緊意義很重要.
然後要在自己腦中或程式註解中描述這些定義描述清楚; 或者在程式寫法或
程式字面上把故事講得很清楚,或者把故事的結構性描述得清楚.
這會變成像是把程式當作文件來寫,應該可以說是 coding 的藝術.

講到藝術,當你修改一副畫的時候,不會因為一時著急就把修補的區塊亂畫;
同理,如果你有心把程式整理得很好,在改每個程式單元時,都應該會回想到
當初所賦與這段程式的意義,以及這段程式的輸入,輸出,以及週邊狀態的一致性,
然後非常小心動筆.


--
※ 發信站: 批踢踢實業坊(ptt.cc)
◆ From: 59.112.224.132
※ 編輯: yauhh           來自: 59.112.224.132       (02/16 23:20)
推 hero234pq:好文章 推~ Thanks
推 meltice:我一行都不想動 牽一髮而動全身啊
→ meltice:就算前人的code我也只敢用#if 0
→ meltice:然後整個code就是亂七八糟的
→ adrianshum:#if 0 和動了有什麼分別... orz
→ adrianshum:有用任何 SCM 就能找回舊 code 了，
→ adrianshum:#if 0 根本於事無補..