小弟目前在一个私人机构负责写后端的运算程式
而我老板是程式门外汉,个性谨慎且负责,他希望自己能看懂我每一个步骤在干嘛
我目前有写了一份说明文件,将整个程式逻辑跟每一步过程用文字及图片进行解说
例如:
步骤(一):
程式码会读入资料夹"Input/"底下所有的文件,根据文件的档名进行分类,
将档名中含有数字的文件另存入资料夹"Number/"底下,并清空"Input/"底下所有文件。
步骤(二):
接者,程式码会继续将blabla.....
但老板不太满意 他希望我像前人一样
再写一份文件,逐行解释每一行的程式码在做什么事
例如:
行数
1~3 注解。
5 引用标头档。
9 定义函式I_love_u。
....
....
30~44 撷取传入的资料并存入暂存阵列中。
小弟在此想跟经验丰富的前辈们讨论,
当你们遇到这种要求时也会选择逐行仔细的用文字解说吗?
或是有其他更有效率的方法能让老板了解你程式码在做的事情?
补充:我老板会希望每一行程式码都能看懂的理由是,当我离开后,团队只剩下老板时
,若有其他人拿着我们的程式码质疑是否写错时,我老板能准确地回答别人的质疑