代码文档

代码文档是开发人员编写代码以创建其功能的最佳版本的一种方式。代码文档使新手能够熟悉特定模块的特定模块,函数等对特定编程语言的习惯。总是建议在调试代码之前使用文档,这有助于您有效地进行调试。例如,您应该能够将您的代码传递给绝对的初学者,他们应该能够以间隔,可读的方式跟随注释,适当的变量名称和结构化代码。

通过评论函数,循环和声明以及将注释视为源代码的一部分来养成习惯可能成为一个非常重要的想法,就像常规代码一样。

在现实世界中评论的一个例子

更多信息:


Contributing to the Guide

This open source guide is curated by thousands of contributors. You can help by researching, writing and updating these articles. It is an easy and fun way to get started with contributing to open source.