第44节 全都是写
1、代码要跟文档紧密结合,我们要认真对待注释及文档,他们不是可有可无的东西。
2、我们喜欢看到简单的模块级头注释,关于重要数据和类型声明的注释,以及给每个类和每个方法所加的简要头注释,用于描述函数的用法和任何不明了的事情。
3、应当使用特定的格式进行注释,通常对应语言或者 IDE 有推荐的注释格式。
4、可执行文档,即使按照特定格式进行注释,然后利用工具提取注释内容并生成文档。例如 JavaDoc
5、有时文档撰写者和开发并不是同一人,但他们应当接受同样的原则,特别是 DRY,正交性,以及自动化原则等。
iOS也有一个文档生成工具:jazzy,支持 OC 和 Swift,它可以根据标准的注释生成文档。
第45节 极大的期望
1、某个项目团队奇迹般的完成了一个非常复杂的项目,但却遭到用户抵制,原因是该引用没有帮助系统。所以考虑现实,项目的成功是由它在多大程度上满足了用户的期望来衡量的。
2、要与客户之间多交流期望,了解他们的需求,而不是一味沉溺在技术的世界里。
3、适当制造惊喜,会有些通用性的技巧能让项目获得更好的体验。比如:
- 气球式帮助
- 快捷键
- 日志文件分析器
- 自动化安装