※ 引述《StubbornLin (Victor)》之銘言：
: 我發現除了寫程式之外
: 網頁的document也是很重要的
: 如果一個網站如果是像拋棄式的產品那樣
: 有沒有document是沒什麼差
: 可是當一個網站如果是長期經營的
: document就很重要
: 雖然說我正在做的某些網頁
: 全部是由我一個人去做的
: 但是即使是我自己，也會忘記當時的一些東西
: 更別說是別人，程式的註解是不用說的
: 除此之外還有document要寫，當要維護時如果有document可以看
: 就可以更快進入狀況，而不是花很多時間在於了解一些有的沒有的
: 就拿template來說，我之前寫了一兩個網頁程式
: template的部份都是直接網頁做好就套上去
: 但是當這次要寫時，我想到一個問題
: 就是...如果我過一陣子回來看
: 我怎麼知道這個template到底有什麼變數可以使用?
: 如果說 這個template要交給別人設計
: 他總不可能看我程式碼來決定這個頁面到底有什麼
: 而光看template也會遺漏一些預留的東西
: 這時，document就派上用場了
: 所以我現在寫有輸出頁面的程式
: 都會寫該頁面所對應的template的document
: 說明有哪些變數可以引用 還有範例
: 也就是說可以直接引入該document來當做template做各種輸出的測試
: 除了template，另一個很需要document的地方，我想應該就是database的table了
: 很多時候資料表開一開，經過一段時間再回來看，當初開這些欄位在幹麻的
: 這個表在幹麻的，很難光從名字就知道，很多情況下非得去翻程式
: 看這些資料是怎樣被存取的
: 所以我想請問一下
: 有沒有什麼關於網頁的document的心得
: 應該怎樣寫，有什麼需要寫
: 還是工具、技巧等等的
: 以上，謝謝
拆成 HTML 顯示
DB SQL
跟 程式邏輯 三個部份
如果三者混在一起 除錯或者之後要維護都會東找西找....
所以整頁程式....
先做SQL的取值
再用程式處理SQL的數值
最後用頁面顯示處理的結果....
顯示頁面 表格的部份可以加一些註解幫助頁面的排版....
DB SQL 所有的資料庫要留 資料字典下來....可能值要列清楚....
程式邏輯就可以加上範例之類的 說明....
變數命名的時候可以用型態加上駝峰字表示....
至少知道他會是處理什麼數值為主....
再加上排版....應該就差不多了....
如果你測試案例有寫那就更好了....
淺見....
--
※ 發信站: 批踢踢實業坊(ptt.cc)
◆ From: 140.122.79.73