軟件公司最常用的網站開發政策是什麼？

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在生產服務器上，除非它被提交到存儲庫。
• 如果一個項目提供重構舊代碼的機會，請抓住這個機會。
• 維持維基或類似文件的程序，標準和使用的庫代碼（當這種文件是太多代碼註釋）