软件公司中最常用的Web开发策略是什么？

Question

在开发人员中拥有最好的论坛网站，我想我会找到一个非常好的共识，即哪些政策和最佳实践能够做出良好的编码。我会把他们中的一些放在这里，所以我给出了这个想法，但我想听听你的意见，投票可能会成为最好的政策的判断。

• 开发团队之间编码的特定缩进
• 每个方法之前的特定注释，在每个变量声明之前
• 命名约定，驼峰案例或任何其他。
• 在每个容器标记之后的HTML注释中。
• 在CSS中，仅使用每个声明一次。

你明白了。我想知道公司要求我们做什么，以及那些真正有效的方法来获得可维护和漂亮的代码。

Answer 1

我会围绕开发实践而不是代码格式化来关注任何策略。一些例子是：

• 始终使用参数化SQL查询。切勿将用户输入连接到查询中。
• 将HTML，CSS和JavaScript保存在单独的文件中。
• 在每次时间提交代码时使用jslint或等效工具。
• 选择HTML标准（例如HTML 4.01严格）。所有HTML都必须验证。

不要成为政策纳粹。有时必须打破规则 - 但这样做应该有很好的理由。

Answer 2

• 如果代码不受版本控制，则代码不存在。更具体地说，NOTHING在生产服务器上，除非它已提交到存储库。
• 如果项目提供了重构旧代码的机会，请抓住机会。
• 维护一个wiki或类似的文档程序，标准和库代码的使用（当这些文档对代码注释来说太多时）

Answer 3

（对于PHP项目，至少 - 注意PHP是开源的，并且有一个重要的社区;因此，很多事情都是由社区中的工作驱动的）

首先，当在项目上使用框架（即，总是）时，我们会尝试坚持其策略，如果明确定义（至少是Zend Framework的情况）：它确保任何前来参与该项目的人都可以：

• 找到标准的定义
• 在使用相同框架的任何其他项目上重复使用它
  • 即使去另一家公司，或为另一个客户工作
  • 或来自其他公司; - ）

考虑到我们在我工作的公司中只使用3到5个PHP项目框架，并且他们的标准中定义的许多规则是相同的，这不是一个真正的问题。

同样适用于在某些CMS内部/ arround编码，例如，当然。

当不使用特定框架时，​​我们会尝试坚持PHP社区中广泛接受的一套通用规则：同样，它确保这些规则是众所周知的（即使是我们公司的新成员），很容易找到，很多人都尝试过并加强它们。

关于评论，有一个在PHP中很常用的工具：phpDocumentor （与javadoc大致相同）;它定义了一个标准 - 这个是事实上的标准，因为没有其他工具可以使用那么多。

关于特定评论标签：

• 我们总是使用@param / @return：它们集成在IDE中，提供类型提示，因此非常有用
• 否则，我们不会使用太多：如果不明显的话，可以说几行：如果使用困难的算法，可以使用几行。

Camel-case或其他：我们坚持PHP社区和框架中的常见内容：

this_is_a_function

和

ThisIsAClassName

和

thisIsAMethodName

在HTML中：我们尽可能不使用HTML注释，因为它们被发送到浏览器：

• 意味着更大的页面（好吧，不是那么多）
• 表示提供用户不需要的信息

如果可能，我们使用模板引擎的评论。

在CSS中：我们在需要时发表评论;更重要的是使用几个小的CSS文件，非常具体（即使在构建过程中使用合并工具）

但是，也许比这一切更重要：我们尝试使用“干净”的代码，使用小方法，只做一个小的“单位”的事情，自我描述的名称和所有

它没有魔法，但它有助于理解代码......而且，测试它，重新使用它，......

另外，正如Nate所说：这些主要是指导原则 - 除非客户明确要求......在这种情况下你必须放置一些自动工具（例如在你的构建过程中）来验证接下来是信件。