什么是必要的项目到文档上的代码？

Question

存在这样可以将代码文档中提到的每一个编程语言这么多的选项。

我想知道什么是我们有记录的最重要的项目？

Answer 1

我想记录的合同（该参数预期不为空，这个函数永远不会返回NULL，...）以及含义（此方法不说，...）。除记录的API，我想补充的代码段，其是不平凡的意见，但添加显著价值的应用程序（神秘，但真正快速，围绕着一个框架的bug）。

你的文件最终取决于谁将阅读该文件的文件...