最近小弟的工作是在帮部门写一些interface functing的文件， 为的是某些module要交给其他部分使用，我被要求写一些类似MSDN的文件， 描叙function的功能、传入参数、回传值，这看似相当普遍的工作， 但当我真的开始着手进行时，发现了一些困难点， 让我觉得文件这种东西是，食之无味、弃之可惜，甚至是拿来做样子当挡箭牌。 因为module的行为往往十分复杂，搞得interface也很窒碍难懂， 面对面沟通再加上画图都讲不清楚，更何况是用文字? 还是Chinese English? 复杂的还不只function本身，连代入的参数也可能高达七八个， 甚至还有一些是自订的structure，里面包什麽还得另外看， 代入的东西还有reference value，去取值用的，以及callback function， 这简直一发不可收拾.... 我在公司部门里算资浅的，面对这些问题的时候虽然会存疑，但也不敢表示什麽， 写这些interface的同事也许是自己已经很熟悉，总是认为已经很简单很方便了， 有时真的搞不清是自己理解能力太差，还是这些interface真的太复杂? "了解别人在做什麽" 这句话讲起来真的是正气凛然无法反驳， 但我一直认为module最好做到跟外界绝缘，interface要简单到近乎愚蠢， 以一个使用者的角度来看，我根本懒得去知道这module里头怎麽实作， 我只想知道它可以做什麽，而且最好你可以教会我，别让我还得自己去看code。 不过我不敢跟其他人这样说...科科~ 我不知道这算不算软工的范围，也觉得这问题感觉上小不拉机似乎拿不上抬面， 但小弟资质愚鲁，怎麽想都想不透怎样的作法才是对的? 望有想法的前辈可以不吝指教，拜谢。 -- 为什麽那边那个人那麽伤心呢? ││││││ 因为他是台湾人啊，吃的比我们还毒哩! 2.5ppm ˍ︵ │││ 还好我们 0.5ppm ꈠꈠ2ppm ╱ ╱▏ ││ 不用吃… ꈠ ꈠ ◤ ◥ │￣▏ ˍ 0ppm | | | ╱ ╱ ꈠ 兞1m◢ ꄠ （||） ω ꈠㄦ --

※ 发信站: 批踢踢实业坊(ptt.cc) ◆ From: 221.169.231.18 ※ darkkiwi:转录至看板 Tech_Job 11/29 13:38