[問題] 讓不會寫程式的老闆看懂我的Code
小弟目前在一個私人機構負責寫後端的運算程式
而我老闆是程式門外漢,個性謹慎且負責,他希望自己能看懂我每一個步驟在幹嘛
我目前有寫了一份說明文件,將整個程式邏輯跟每一步過程用文字及圖片進行解說
例如:
步驟(一):
程式碼會讀入資料夾"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
→
03/05 22:12, , 1F
03/05 22:12, 1F
→
03/05 22:19, , 2F
03/05 22:19, 2F
→
03/05 22:19, , 3F
03/05 22:19, 3F
→
03/05 22:32, , 4F
03/05 22:32, 4F
推
03/05 22:34, , 5F
03/05 22:34, 5F
推
03/05 23:52, , 6F
03/05 23:52, 6F
推
03/06 02:24, , 7F
03/06 02:24, 7F
→
03/06 02:25, , 8F
03/06 02:25, 8F
推
03/06 02:29, , 9F
03/06 02:29, 9F
推
03/06 04:44, , 10F
03/06 04:44, 10F
推
03/06 08:00, , 11F
03/06 08:00, 11F
→
03/06 16:32, , 12F
03/06 16:32, 12F
推
03/06 18:20, , 13F
03/06 18:20, 13F
推
03/06 20:34, , 14F
03/06 20:34, 14F
推
03/06 22:45, , 15F
03/06 22:45, 15F
→
03/07 08:00, , 16F
03/07 08:00, 16F
→
03/07 08:46, , 17F
03/07 08:46, 17F
→
03/07 08:47, , 18F
03/07 08:47, 18F
→
03/07 08:47, , 19F
03/07 08:47, 19F
→
03/07 08:48, , 20F
03/07 08:48, 20F
→
03/07 08:49, , 21F
03/07 08:49, 21F
→
03/07 12:50, , 22F
03/07 12:50, 22F
→
03/07 12:51, , 23F
03/07 12:51, 23F
推
03/07 15:25, , 24F
03/07 15:25, 24F
推
03/07 18:48, , 25F
03/07 18:48, 25F
→
03/07 22:43, , 26F
03/07 22:43, 26F
→
03/08 01:25, , 27F
03/08 01:25, 27F
→
03/08 01:25, , 28F
03/08 01:25, 28F
→
03/08 10:11, , 29F
03/08 10:11, 29F
→
03/08 10:56, , 30F
03/08 10:56, 30F
推
03/08 12:23, , 31F
03/08 12:23, 31F
推
03/08 12:54, , 32F
03/08 12:54, 32F
推
03/08 18:29, , 33F
03/08 18:29, 33F
→
03/12 14:08, , 34F
03/12 14:08, 34F
→
03/12 14:08, , 35F
03/12 14:08, 35F
→
03/15 15:54, , 36F
03/15 15:54, 36F
→
03/15 15:59, , 37F
03/15 15:59, 37F
→
03/15 15:59, , 38F
03/15 15:59, 38F
→
03/19 20:47, , 39F
03/19 20:47, 39F
→
03/19 20:48, , 40F
03/19 20:48, 40F