Web开发人员文档的重要性 - 福州APP开发福州软件开发福州小程序开发福州网站开发

在移动，Web和桌面应用程序或JavaScript库的开发领域中，文档在确定应用程序的成功方面起着重要作用。但是，如果您曾经做过文档编制，那么您会同意我的看法，这几乎是开发人员最不喜欢做的事情。

与编写代码（这是开发人员签约的工作）不同，文档必须易于所有人共享。从技术上讲，我们必须将机器语言（代码）翻译成人类可以理解的语言，这比听起来要难。

尽管这可能会带来很大的负担，但是编写文档很重要，并且可以为您的用户，您的同事，尤其是您自己带来好处。

学习编程：10个不正确的误解

围绕编程艺术存在很多误解和神话。许多人将其视为工作…阅读更多

好的文档可以帮助用户

显然，文档可以帮助读者理解代码的工作原理。但是许多开发人员错误地认为该软件的用户会精通。因此，文档可能是很薄的材料，从一开始就跳过了它应该包含的许多要点。如果您精通该语言，则可以自行解决。如果不是，那你就迷路了。

供用户使用的文档通常由实际使用或“操作方法”组成。为一般用户创建文档时的经验法则是，它应该明确。使用对人类友好的单词比使用专业术语或专业术语更为可取。实际使用的示例也将不胜感激。

良好的布局设计还可以真正帮助用户轻松浏览文档的每个部分。Bootstrap和WordPress的文档“ WordPress的第一步” 是一些很好的示例（又名我的最爱）。

它可以帮助其他开发人员

每个开发人员都有自己的编码风格。但是，在团队合作中，我们经常必须与其他队友共享代码。因此，有必要就一项标准达成共识，以使所有人保持一致。适当书面文档将是团队需要的参考

但是，与最终用户文档不同，该文档通常描述诸如代码命名约定之类的技术过程，显示应如何构造特定页面，以及API如何与代码示例一起工作。通常，我们还必须与代码内联地编写文档（称为注释），以描述代码的作用。

此外，如果以后有新成员加入团队，此文档可能是培训他们的省时方法，因此您不必在代码上进行一对一的冲突。

开发人员应该采用的10种编程习惯

这些结果可能会降低我们的信心，但实际上，可以通过适当的开发实践来解决它们。阅读更多

它也可以帮助编码员自己

关于编码的有趣之处在于，有时甚至开发人员本身也不理解他们编写的代码。在几个月甚至几年都没有修改密码的情况下，尤其如此。

突然出于某种原因需要重新访问代码会使人们想知道在编写这些代码时他们在想什么。不要惊讶：我以前就处于这种情况。这正是我希望正确记录我的代码的时间。

通过记录您的代码，您将能够快速而又深入地探究代码的底部，从而节省了许多时间，这些时间可用于完成更改。

是什么构成好的文档？

有几个因素可以帮助您构建出良好的文档。一些最重要的如下：

1.永远不要假设

不要假设你的用户知道你知道还有什么，他们想知道的。无论用户的熟练程度如何，始终从头开始总是更好。

例如，如果您构建了jQuery插件，则可以从SlickJS的文档中获得启发。它显示了如何构造HTML，放置CSS和JavaScript的位置，如何在最基本的级别上初始化jQuery插件，甚至还显示了添加所有这些内容后的完整最终标记，这是显而易见的。

最重要的是，文档是根据用户而不是开发人员的思考过程编写的。以这种方式处理您自己的文档将为您提供更好的视角来组织自己的作品。

2.遵守标准

在添加与代码内联的文档时，请使用该语言的预期标准。描述每个函数，变量以及函数返回的值始终是一个好主意。这是一个很好的PHP内联文档示例。

/**
 * Adds custom classes to the array of body classes.
 *
 * @param array $classes Classes for the body element.
 * @return array
 */
function body_classes( $classes ) {
  // Adds a class of group-blog to blogs with more than 1 published author.
  if ( is_multi_author() ) {
    $classes[] = 'group-blog';
  }
  return $classes;
}
add_filter( 'body_class', 'body_classes' );