Re: [閒聊] 主管要求註解代替刪除

[scasur (Wei)]

※ 引述《scasur (Wei)》之銘言：
: 是這樣的，主管最近要求凡是修改檔案一律
: 1. 以註解夾住修改的地方
: 2. 原本的程式註解掉，不要刪掉

謝謝大家的意見!

推文講到的，我都有參考。 NDark 的建議很實用，我也有在會議上提出~

我還滿幸運的，主管們肯聽我們的想法，以及花時間討論。
我花了2天的時間整理我論點，可行的建議，寫了一篇9頁、2000多字的圖文並茂的抗辯書
(不過我覺得花時間做這件事很值得，而且口頭討論很容易離題。)

昨天先對話交鋒一回合，然後今天上戰場繼續討(ㄅㄧㄢˋ)論 XD

整個部門都拉進來了 一階跟二階主管
(所以昨天才上PTT尋求火力支援! 然後出門去看了BBS鄉民的正義XD。ps.陳意涵好可愛)

我們主管會這樣要求，也是有苦衷的。我們部門提供整個公司的各種業務需求，前台後台
各種共用性非常氾濫，資料庫、交易程式、報表程式都有跨部門共同使用的可能。再加上
需求很常變更。我們主管面對的問題:

1. 當有user打電話來問問題的時候，他希望可以很快找到為什麼這樣做。
   所以他看code，看夾起來的需求單單號，然後回應對方，
   證明是有人要求我們這樣做的，而不是我們的問題。

2. 他希望看同仁這次改了甚麼地方，因為有Begin-End夾起來，
   可以用ctrl+f就找到測試的時候把中斷點設在那邊，邊看邊執行。
   用版本控管要切來切去。

3. 他想要看到過去的歷程，原因:
   3-1 原本甲寫的是對的，乙改壞了，可以看的出來。
   3-2 user的需求從A變成B，現在要變成A。
       就可以發現，咦! 你之前才把A改成B，你確定要改回來?

大概就是這樣。我的回應是

   1. 用一行的註解，註明邏輯做法，和單號(或日期)。
      這樣知道單號後就知道版後，就可以進去看比對表。

   2. 我沒回。沒想到會有這麼奇怪的測試方法，出乎意料之外XDD

   3-1. 好像話題被轉走了，沒回到。
        OS是: 知道了，然後呢? 是要叫表揚甲還是要叫B改回來?

   3-2. 他忘了提出來。不過我也想不到解法，頂多用文字說明註明之前的作法。

怎麼寫一寫好像他的要求很合理。其實我不是反對這樣做。
只是應該視情況而為，而不是走火入魔地改甚麼東西都大費周章的手動版本控管。
我改很大的時候也會怕怕的不敢刪，會先註解起來，但沒問題後下次遇到就刪了。

不曉得各位先進平常會有這種問題嗎?
我仔細想想，我負責的系統好像還真的沒有他那種需求，
不曉得是因為我負責的東西沒那麼有爭議還是怎樣。



--
※ 發信站: 批踢踢實業坊(ptt.cc) 
◆ From: 111.248.152.225
推 KSmart:我的作法是，小部分的修改(1.2行)會保留原先的Code(如下)
→ KSmart:// string errMessage = "";  <--舊的Code
→ KSmart:string errMessage = "錯誤訊息"; //20120913 Add by XXX
→ KSmart:或string errMessage="錯誤訊息";//20120913 Modify by XXX
→ enthos:建議原PO負責寫一個自動checkout的script,自動輸出所需內容
推 chrischen:看變更用ctrl+f真是匪夷所思...diff工具好用多了...
推 nenpow:其實用註解的方法也還好吧，現在IDE不是都有code folding?
推 Maisky:JoelTest第一關就失敗了,不能接受版本管理的話儘早離開才好
→ StubbornLin:開發一些簡單的工具去版本控制系統撈資料滿足他需求
→ StubbornLin:不就得了 滿足他不懂工具的需求vs犧牲整體開發生產力
→ StubbornLin:這需要比嗎 = =
推 NetsFan:應該用added modified 台式英文都不分
→ NetsFan:主動被動
→ TonyQ:它一定沒用過版本控制系統的 annotation 功能...
→ TonyQ:這些基本上都是 svn blame 這個功能可以解決的，他可以一行
→ TonyQ:一行列出最近修改版號是哪一版，顯示歷程...比這種comment法
→ TonyQ:好上千倍。