[问题] 让不会写程式的老板看懂我的Code

楼主: iwantstronge (...)   2016-03-05 22:09:09
小弟目前在一个私人机构负责写后端的运算程式
而我老板是程式门外汉,个性谨慎且负责,他希望自己能看懂我每一个步骤在干嘛
我目前有写了一份说明文件,将整个程式逻辑跟每一步过程用文字及图片进行解说
例如:
步骤(一):
程式码会读入资料夹"Input/"底下所有的文件,根据文件的档名进行分类,
将档名中含有数字的文件另存入资料夹"Number/"底下,并清空"Input/"底下所有文件。
步骤(二):
接者,程式码会继续将blabla.....
但老板不太满意 他希望我像前人一样 
再写一份文件,逐行解释每一行的程式码在做什么事
例如:
行数
1~3 注解。
5 引用标头档。
9 定义函式I_love_u。
....
....
30~44 撷取传入的资料并存入暂存阵列中。
小弟在此想跟经验丰富的前辈们讨论,
当你们遇到这种要求时也会选择逐行仔细的用文字解说吗?
或是有其他更有效率的方法能让老板了解你程式码在做的事情?
补充:我老板会希望每一行程式码都能看懂的理由是,当我离开后,团队只剩下老板时
,若有其他人拿着我们的程式码质疑是否写错时,我老板能准确地回答别人的质疑
作者: flydragon198 (Richard)   2016-03-05 22:12:00
换个老板........
楼主: iwantstronge (...)   2016-03-05 22:19:00
1F 我老板也知道我在几个月后就要离开 因此他才希望我能完成这件事 我在苦恼于是否有更好的方式?
作者: uranusjr (←這人是超級笨蛋)   2016-03-05 22:32:00
既然已经要走了就做吧, 然后这几个月就只做这件事
作者: ronin728 (浪人)   2016-03-05 22:34:00
Literate Programming,然后拿Knuth的大名出来说服他XD
作者: clanguage (C语言)   2016-03-05 23:52:00
找个人交接 教他 让他去写
作者: overhead (overhead)   2016-03-06 02:24:00
反正你只剩几个月 这段时间内他要你干嘛你就干嘛吧时间到就走人。是说你换工作的决定是绝对正确的...
作者: ah7675 (阿毛)   2016-03-06 02:29:00
老板应该是年纪蛮大的吧 就帮帮他吧
作者: layan (教练我想打球 T_T)   2016-03-06 04:44:00
哇塞这个要求超瞎的
作者: johnpage (johnpage)   2016-03-06 08:00:00
老板知道,那你的价值呢?
作者: james732 (好人超)   2016-03-06 16:32:00
既然都要走了,随便写一写他也看不懂对不对啊XDDD
作者: ggBird (ggBird)   2016-03-06 18:20:00
你再怎么写他写看不懂啦
作者: EdisonX (卡卡兽)   2016-03-06 20:34:00
叫老板多念点书。 XD
作者: kattte (诚实面对自己吧!)   2016-03-06 22:45:00
有种国王的新衣的感觉
作者: lucky1lk (赌到没钱的人)   2016-03-07 08:00:00
这位老板有"基础"吗?
作者: noonee (我和烤肉间只差一撮孜然)   2016-03-07 08:46:00
一定程度上来说 你该听他的因为你是在公司雇用你的情况下写的那个code在他没要求你做违法或是违反道德的前提下 没理由不听他的如果不想听他的 应该尽快找别的工作当然 如果这些要求拖到公司的进度 责任在他不在你
作者: flighteagle (班机鹰)   2016-03-07 12:50:00
这对看懂code一点帮助都没有, 知道架构又能如何何况这架构只是前人说, 不是自己真的了解
作者: agreerga (鸭毛)   2016-03-07 15:25:00
你应该建议你老板先去学程式
作者: longlongint (华哥尔)   2016-03-07 18:48:00
老板很棒 你学弟会很爱你
作者: zetab   2016-03-07 22:43:00
遇到程式改版行号改变 文件就改到吐血了 真不愧是门外汉
作者: noonee (我和烤肉间只差一撮孜然)   2016-03-08 01:25:00
楼上这个不是问题 以我自己来说 就习惯在每一个段落前写这一段是干嘛的 写在段落前就不用管行号
作者: Caesar08 (Caesar)   2016-03-08 10:11:00
楼上,问题是他老板需要知道每一行在干嘛阿
作者: noonee (我和烤肉间只差一撮孜然)   2016-03-08 10:56:00
看内文 应该是一段一段写 不是一行一行写
作者: Clangpp (Clang++)   2016-03-08 12:23:00
叫你老板请一个懂的人比较快啦...
作者: skyhot (Loser)   2016-03-08 12:54:00
跟老板说,我教你,你要算我钟点费
作者: cobrasgo (人鱼线变成鲔鱼线,超帅)   2016-03-08 18:29:00
老板有基础吗
楼主: iwantstronge (...)   2016-03-12 14:08:00
老板完全没基础,而前人的确是有另外写一份逐行说明的文件。 我目前打算先分段说明,看老板满不满意
作者: narcissusli   2016-03-15 15:54:00
拿巨匠电脑的名片给他啊前老板把员工当贼,一样的行径+一样的弱鸡。想从员工的code中求成长,无奈烂泥扶不上墙
作者: Schottky (顺风相送)   2016-03-19 20:47:00
逐行"英"翻中这种注解看得懂我随便你...noonee 的段落注解我想至少也是高阶一点的作法说明

Links booklink

Contact Us: admin [ a t ] ucptt.com