看板 C_and_CPP 關於我們 聯絡資訊
小弟目前在一個私人機構負責寫後端的運算程式 而我老闆是程式門外漢,個性謹慎且負責,他希望自己能看懂我每一個步驟在幹嘛 我目前有寫了一份說明文件,將整個程式邏輯跟每一步過程用文字及圖片進行解說 例如: 步驟(一): 程式碼會讀入資料夾"Input/"底下所有的文件,根據文件的檔名進行分類, 將檔名中含有數字的文件另存入資料夾"Number/"底下,並清空"Input/"底下所有文件。 步驟(二): 接者,程式碼會繼續將blabla..... 但老闆不太滿意 他希望我像前人一樣  再寫一份文件,逐行解釋每一行的程式碼在做甚麼事 例如: 行數 1~3 註解。 5 引用標頭檔。 9 定義函式I_love_u。 .... .... 30~44 擷取傳入的資料並存入暫存陣列中。 小弟在此想跟經驗豐富的前輩們討論, 當你們遇到這種要求時也會選擇逐行仔細的用文字解說嗎? 或是有其他更有效率的方法能讓老闆了解你程式碼在做的事情? 補充:我老闆會希望每一行程式碼都能看懂的理由是,當我離開後,團隊只剩下老闆時 ,若有其他人拿著我們的程式碼質疑是否寫錯時,我老闆能準確地回答別人的質疑 -- ※ 發信站: 批踢踢實業坊(ptt.cc), 來自: 180.217.17.1 ※ 文章網址: https://www.ptt.cc/bbs/C_and_CPP/M.1457186951.A.210.html ※ 編輯: iwantstronge (180.217.17.1), 03/05/2016 22:14:34
flydragon198: 換個老闆........ 03/05 22:12
iwantstronge: 1F 我老闆也知道我在幾個月後就要離開 因此他才希望 03/05 22:19
iwantstronge: 我能完成這件事 我在苦惱於是否有更好的方式? 03/05 22:19
uranusjr: 既然已經要走了就做吧, 然後這幾個月就只做這件事 03/05 22:32
ronin728: Literate Programming,然後拿Knuth的大名出來說服他XD 03/05 22:34
clanguage: 找個人交接 教他 讓他去寫 03/05 23:52
overhead: 反正你只剩幾個月 這段時間內他要你幹嘛你就幹嘛吧 03/06 02:24
overhead: 時間到就走人。是說你換工作的決定是絕對正確的... 03/06 02:25
ah7675: 老闆應該是年紀蠻大的吧 就幫幫他吧 03/06 02:29
layan: 哇塞這個要求超瞎的 03/06 04:44
johnpage: 老板知道,那你的價值呢? 03/06 08:00
james732: 既然都要走了,隨便寫一寫他也看不懂對不對啊XDDD 03/06 16:32
ggBird: 你再怎麼寫他寫看不懂啦 03/06 18:20
EdisonX: 叫老闆多念點書。 XD 03/06 20:34
kattte: 有種國王的新衣的感覺 03/06 22:45
lucky1lk: 這位老闆有"基礎"嗎? 03/07 08:00
noonee: 一定程度上來說 你該聽他的 03/07 08:46
noonee: 因為你是在公司僱用你的情況下寫的那個code 03/07 08:47
noonee: 在他沒要求你做違法或是違反道德的前提下 沒理由不聽他的 03/07 08:47
noonee: 如果不想聽他的 應該儘快找別的工作 03/07 08:48
noonee: 當然 如果這些要求拖到公司的進度 責任在他不在你 03/07 08:49
flighteagle: 這對看懂code一點幫助都沒有, 知道架構又能如何 03/07 12:50
flighteagle: 何況這架構只是前人說, 不是自己真的了解 03/07 12:51
agreerga: 你應該建議你老闆先去學程式 03/07 15:25
longlongint: 老闆很棒 你學弟會很愛你 03/07 18:48
zetab: 遇到程式改版行號改變 文件就改到吐血了 真不愧是門外漢 03/07 22:43
noonee: 樓上這個不是問題 以我自己來說 就習慣在每一個段落前寫 03/08 01:25
noonee: 這一段是幹嘛的 寫在段落前就不用管行號 03/08 01:25
Caesar08: 樓上,問題是他老闆需要知道每一行在幹嘛阿 03/08 10:11
noonee: 看內文 應該是一段一段寫 不是一行一行寫 03/08 10:56
Clangpp: 叫你老闆請一個懂的人比較快啦... 03/08 12:23
skyhot: 跟老闆說,我教你,你要算我鐘點費 03/08 12:54
cobrasgo: 老板有基礎嗎 03/08 18:29
iwantstronge: 老闆完全沒基礎,而前人的確是有另外寫一份逐行說 03/12 14:08
iwantstronge: 明的文件。 我目前打算先分段說明,看老闆滿不滿意 03/12 14:08
narcissusli: 拿巨匠電腦的名片給他啊 03/15 15:54
narcissusli: 前老闆把員工當賊,一樣的行徑+一樣的弱雞。想從員工 03/15 15:59
narcissusli: 的code中求成長,無奈爛泥扶不上牆 03/15 15:59
Schottky: 逐行"英"翻中這種註解看得懂我隨便你... 03/19 20:47
Schottky: noonee 的段落註解我想至少也是高階一點的作法說明 03/19 20:48