标签：
区分用户说明文档和技术说明文档。
替模块和应用程序创建标准POD模板。
把你的标准POD模板予以扩展和自定义。
在源代码文件中放置用户说明文档。
把所有用户说明文档放在源代码文件中的单独的地方。
尽可能把POD放在靠近文件末尾处。
对技术说明文档做适当的细化。
主要注释应使用块模板。
使用整行注释来说明算法。
使用行尾注释来指出微妙之处和奇怪之处。
对任何让你困惑或受骗的东西都要做注释。
考虑改写是否比做注释更好。
较长的技术讨论内容要使用“看不见”的POD段落。
检查说明文档的拼写、语法以及健全性。
标签：
原文地址：http://www.cnblogs.com/xiaobin-hlj80/p/5188442.html
