Javascript架構跟開發規範

Posted on Edited on In Views: Disqus: Symbols count in article: 483 Reading time ≈ 1 mins.

Javascript架構跟開發規範

介紹Javascript的架構及開發規範，提供參考。

重要原則

1
2
3
4
5
6
7
8
9
10
11
1. Javascript的相關程式儘量不要直接寫在jsp頁面上，請開一個獨立的js檔案放置，因為JSP會被 tomcat編譯成servlet，
   所以相關的javascript程式碼都會被轉成字串物件並放入Tomcat的string pool裡面，並佔用到server的記憶體，而獨立的js檔案則不會有這樣的問題

2. JSP的註解請儘量使用<%--  --%>，這種屬於server端的註解，而不是使用<!--  -->，這種屬於瀏覽器端的註解
a. Server端的註解 : 並不會傳到瀏覽器端，而且不會佔用到Server的記憶體
b. 瀏覽器端的註解 : 當檢視網頁原始碼的時候可以看到，只是不會被瀏覽器執行，但這些註解會佔用到Server端的記憶體跟耗損網站頻寬

3. Javascript命名請依照Java命名，讓其他同事在閱讀時能保持一致性

4. 一個頁面上如果功能複雜，請依照頁面切出功能區塊，每個功能區塊由單一Javascript物件去管控，避免混亂