※ 引述《[email protected] (风起鹰扬)》之铭言： : ※ 引述《lxb ()》之铭言： : : 这样想吧, ptt 的维护队伍已经在前线开发上付出了很多, : : 而我们这些小站台除了受惠外, 有点余力就不妨做一下 documents. : : 说不定这样子 ptt 的维护队, 可以更专心地解决我们提出的问题. : : 各方面要择取本身的优势, 合作才会比较顺. : : 像我这边就是较多留意到小站台会关心的地方, 同时也有一定的开发能力, : : 所以我不怕自己菜, 就留独到理解, 而先提出想法给大家参考. : : 其他站台也可以做到不同的贡献的, 有时, 单单是发表 source code 中 : : 理解不到的地方, 也可以刺激到讨论, 有助於蒐集 FAQ. : 我之前曾在 source code 里面，用 javadoc 那种方式来写注解 (硬写的 XD 见 : docs/proto/) 当时的想法是，我帮我看懂的 code 注解一下，之後的人就不必重 : 新去理解 (当然太 detail 或是已经很 trivial 的东西就不必了)。不过後来好像 : 只有我在写，我也一段时间没碰了，所以没新东西 :p : (我这里指的文件都是指开发人员需要看的部分。) 　　我觉得开发上所需要的document，并不是注解或者像javadoc那 些东西可以解决的。除了一些本身比较古怪的code，ptt的程式并不 算难看懂了。 　　真正需要的是一个跨程序跨模组的说明文件。举个例，水球系统 ，在哪个程序触发启动，哪个程序编辑讯息，哪个程序收信息，水球 资料放在哪里，以怎样的格式，整个流程是怎样？其实不少功能都分 布在不同档案不同函数里，而且运作方式也不容易理解，跟踪程式流 程和理解其运作方法就花了大部份时间，真正动手修改相较之下反而 十分简单。所以我觉得独立的说明文件对开发最有帮助，程式里的注 解次之。 -- 作者 Starfish (海星) 看板 SYSOPS-chat 标题 [闲聊] 报到 时间 Sun Apr 11 22:24:18 2004 ─────────────────────────────────────── hihi :) --

※ 发信站: 香港地(hkday.net) ◆ From: 218.254.198.186