竹貓星球

發表於 : **2004-02-04 17:46**

以下文章是和有程式經驗和基礎的人交流經驗
coding不熟的人也可以參考

------------------------------------------------
前言:

改php程式不難, 只要有點coding的經驗, 可以說不用書也不用學過php就可以去做修改了
最難的是在maintain的工作上
尤其像phpBB這個open source code的Group Maintain方式, maintain souce就格外重要
在Software Engineering裡, 這叫Quality management

在phpBB中, 我們可以看到的是在寫mod或改mod的人都會製作一個install的manual,
裡面有[ OPEN ][ FIND ][ AFTER, ADD ][ SAVE/CLOSE ALL FILES ]...等等這一類用來maintain source的traces, 這是個很好的現像
但是大家一定也發現, 雖然有這樣的方式來maintain, 但是有時自己想去做局部調整, 或是加外掛時, 外掛和掛外間有不可獨立的關係時, 在做修改就額外困難\r
----------------------------------------------------------
我要說的:

第一種習慣\r

代碼: 選擇全部

# 
#-----[ FIND ]------------------------------------------ 
# 
<td width="40%" valign="top" nowrap="nowrap" align="left"><span class="gensmall">{S_WATCH_TOPIC}</span><br /> 
# 
#-----[ AFTER, ADD ]------------------------------------------ 
# 
     </tr> 
</table>

第二種習慣\r

代碼: 選擇全部

# 
#-----[ FIND ]------------------------------------------ 
# 
<td width="40%" valign="top" nowrap="nowrap" align="left"><span class="gensmall">{S_WATCH_TOPIC}</span><br /> 
# 
#-----[ AFTER, ADD ]------------------------------------------ 
#
[color=red]<!-- XXX_MOD START -->[/color] 
     </tr> 
</table>
[color=red]<!-- XXX_MOD END -->[/color]

第一種習慣\r

代碼: 選擇全部

# 
#-----[ FIND ]------------------------------------------ 
# 
<td width="40%" valign="top" nowrap="nowrap" align="left"><span class="gensmall">{S_WATCH_TOPIC}</span><br /> 
# 
#-----[ REPLACE TO ]------------------------------------------ 
# 
     </tr> 
</table>

第二種習慣\r

代碼: 選擇全部

# 
#-----[ FIND ]------------------------------------------ 
# 
<td width="40%" valign="top" nowrap="nowrap" align="left"><span class="gensmall">{S_WATCH_TOPIC}</span><br /> 
# 
#-----[ REPLACE TO ]------------------------------------------ 
#
[color=red]<!-- XXX_MOD START -->[/color]
[color=red]<!-- BEFORE REPLACE[/color]
<td width="40%" valign="top" nowrap="nowrap" align="left"><span class="gensmall">{S_WATCH_TOPIC}</span><br /> 
[color=red]-->[/color]
     </tr> 
</table>
[color=red]<!-- XXX_MOD END -->[/color]

第二種習慣為修改過的東西加上一些註解,
這樣在做增加多采多姿的各種外掛後, 我們在事後的維護也會輕鬆很多
軟體工程裡也滿注重這個東西
當然不一定要像我寫的方法, 不過 "標準" 是一定要定出來的,
沒有標準, 大家都照著手邊的一些範例在修改, 久而久之, 一定形成大家困擾的
也許有人還不覺得, 也許有人不以為然, 也許有人被困擾過(包括我)
我也只看過幾個mod的作者有這樣的好習慣, 多數都沒有

(也許竹貓可以定個maintain的標準)

------------------------------------------------
嗯 ... 因為覺得phpBB架構理念設計得滿不錯的,
而且因為有網路上各方好手的參與而越來越強大, 但也因如此, 小弟也不希望phpBB發展到一個程度而在大家的維護上會變成一個瓶頸\r

希望phpBB好還要更好囉

大家也可以回文討論交流意見囉

................................................. 一個覺得phpBB是個好軟體的人留

發表於 : **2004-02-04 18:14**

感謝貢獻本文!!

machette 寫:................................................. 一個覺得phpBB是個好軟體的人留

寫這樣子....好像不來了......你別跑啊你.....

確實，在編程的時候，若是能順手加上註解，對於將來的DEBUG或是拆裝、更新都有很大的幫助! (在搜尋關鍵字上能夠非常迅速!!)

代碼: 選擇全部

# 
#-----[ FIND ]------------------------------------------ 
# 
<td width="40%" valign="top" nowrap="nowrap" align="left"><span class="gensmall">{S_WATCH_TOPIC}</span><br /> 
# 
#-----[ AFTER, ADD ]------------------------------------------ 
# 
[color=red]<!-- XXX_MOD START -->[/color] 
     </tr> 
</table> 
[color=red]<!-- XXX_MOD END --> [/color]

我加一點建議

加裝MOD請另外做個紀錄LIST (越詳細越好，比如名稱、下載處、版本、日期等)
安裝日期很重要，因為你將來出了問題，又不知道是哪個MOD造成的，可以經由日期來判斷是哪時候壞的。

發表於 : **2004-02-06 01:43**

要註解的話\r
乾脆仿照Ptirhiik 作者的寫法好了　^^

不過個人覺得　如果註解的部份寫太多東西的話\r
在無形中也加大檔案的大小了　會影響到網站讀取速度　

發表於 : **2004-10-03 15:12**

補充說明～在.php跟.tpl檔案內註解的方式不同喔。
在.php檔案內的註解是這樣

代碼: 選擇全部

// XXX_MOD START

而在.tpl檔案內的註解是這樣

代碼: 選擇全部

<!-- XXX_MOD START -->

若是在.php檔案中使用是不會有註解的效果的，反之亦然。

發表於 : **2005-03-31 10:40**

在PHP裡註解也可以寫成這樣的：

/*我在註解一些東西
看的到了嗎*/

發表於 : **2005-10-29 12:51**

用"#"也可以,
# 呵呵...看到嗎?

竹貓星球

[建議] 給寫MOD或是改MOD的人的一點小建議

[建議] 給寫MOD或是改MOD的人的一點小建議

Re: [建議] 給寫MOD或是改MOD的人的一點小建議