技术文档小贴士 Tips for Technical Documentation

Notice to Authors

为了保障原创作者在本站发表文章的利益, 并维护本站原创的精神, 特声明: RIAShanghai对有以下任何情况之一的文章将不通知作者并直接进行快意删除:

非原创, 或者原创但一文多发;
各种形式的广告与吹擂;
不符合本站文章格式.

欢迎各位读者监督. 谢谢合作. 另: 作为Adobe正式的UG, 我们将把Adobe不定期分发的软件,书籍及各种纪念品赠送给发文活跃的作者, 共同进步.

Navigation

User login

About Us 关于我们

欢迎来到RIA Shanghai社区, 一个专注于大型RIA - Flex, Actionscript, AJAX, etc系统设计研发的综合网站. 欢迎你浏览本站文章, 发表评论(需注册).

在这里你发表任何关于RIA, Flex或者其它相关技术的文章与大家分享交流. 在这个兼容并包的社区里, 不必拘束, 无论是你一两句的技术评论, 还是长篇文章, 一律欢迎 :-) 为了方便你发表文章, 我们还专门提供了离线发布的guide. Enjoy!

All Rights Reserved 原创声明

Newsletter 电子周报

Previous issues

Mon, 10/06/2008 - 15:55 — Jack Li

什么时候需要专门的文档?

除了在代码中加注释外, 如果一个Class/function经常被用到, 那你应该考虑提供专门的文档. 在文档里面, 你需要介绍这个class的存在意义和它提供的功能介绍. 对于一些固定用法, 考虑提供示例代码, 这将极大提高其它开发者的效率. 另外, 一些毕竟tricky和容易犯错的地方, 最好也注明. 你的读者, 也就是包括你自己在内的程序员将打印你的文档做为案头参考资料.