Find centralized, trusted content and collaborate around the technologies you use most.
Teams
Q&A for work
Connect and share knowledge within a single location that is structured and easy to search.
每种编程语言都有很多选项,可以在代码文档中提到。
我想知道我们必须记录的最重要的项目是什么?
我会记录合同(此参数不应为 null,此函数永远不会返回 null,...)以及含义(此方法执行此操作,...)。除了记录 API 之外,我还会对不平凡但为应用程序增加重要价值的代码片段添加注释(神秘但真正快速,解决框架错误)。
您记录的内容最终取决于谁将阅读该文档...