软件公司最常用的网站开发政策是什么？

Question

拥有开发人员中最好的论坛网站，我想我会就什么样的政策和最佳实践能够很好地达成良好的共识。我会将其中的一些放在这里，所以我提出了这个想法，但我希望听取您的意见，而且这些投票可能会成为最佳政策的评判者。

• 具体缩进每种方法之前开发团队之间的编码
• 具体评论，每个变量声明之前
• 命名约定，骆驼情况下或任何其它。
• 在每个容器标签之后的HTML注释中。
• 在CSS中，每个声明只能使用一次。

你明白了。我想知道公司要求我们做什么，以及那些真正能够获得可维护和优美的代码的工具。

Answer 1

我会集中关于开发实践的任何策略，而不是代码格式。一些示例如下：

• 始终使用参数化的SQL查询。永远不要将用户输入串联到一个查询中。
• 将HTML，CSS和JavaScript保存在单独的文件中。
• 使用jslint或等效工具每您提交代码。
• 选择一个HTML标准（如HTML 4.01 strict）。所有的HTML必须验证。

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

Answer 2

（对于PHP项目，至少 - 注意，PHP是开源的，并具有重要的社会，所以，很多事情都相当受什么在社区进行驱动）

首先，当在项目中使用框架（即总是）时，我们试图坚持其政策，如果明确定义的话（Zend Framework至少是这样）：它确保任何参与此项目的人都可以：

• 找到标准的定义
• 重新使用它去另一家公司的时候，或者给其他客户
• 工作或从另一家公司;-)

到来时使用相同的框架

• 甚至任何其他项目

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

  同样适用于编码内部/围绕某种CMS，例如，当然。

  
  当不使用特定的框架中，我们尝试坚持一套共同的PHP社区之间广为接受的规则：同样的方式，确保这些规则是众所周知的（即使是新来者对我们的公司），很容易找到，而且很多人都尝试过并加强它们。

  
  关于注释，有一个工具，在PHP中适当运用：phpDocumentor的（大约同样的事情的javadoc）;它定义了一个标准 - 这是一个事实上的标准，因为没有其他工具可以使用那么多。

  关于具体的意见标签：

  • 我们总是用@param/@return：它们都集成在IDE，提供类型提示，所以是有用的
  • 否则，我们不多用几行：如果不明显，则说明方法的作用;如果使用困难的算法，则需要几行。

  
  驼峰或其它：我们坚持的是共同之间既PHP社区和框架：

  this_is_a_function 
  

  而且

  ThisIsAClassName 
  

  而且

  thisIsAMethodName 
  

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

  • 意味着更大的页面（好吧，不算多）
  • 意味着放弃信息的用户不需要

  如果可能，我们使用模板引擎的注释。

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

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

  它不会做魔法，但它有助于理解代码...并且，还有，测试它，重新使用它，...

  
  另外，正如Nate所说：这些大多是指导方针 - 除非客户特别要求...在这种情况下，你必须把一些自动工具（例如在你的构建过程中）来验证它们后面跟着这个字母。

Answer 3

• 如果代码不在版本控制之下，代码不存在。更具体地说，NOTHING在生产服务器上，除非它被提交到存储库。
• 如果一个项目提供重构旧代码的机会，请抓住这个机会。
• 维持维基或类似文件的程序，标准和使用的库代码（当这种文件是太多代码注释）