Drupal: 寫更清晰的版型程式碼

中文化，我們都有一份規範指引，讓大家翻譯質量更好。程式碼當然也要寫好一點以便易於閱讀。如果你是發佈模組或很神經質的人，請參考 Drupal Coding Standards。亦可使用 Coder 來提升程式碼品質。

在這裏，我針對常接觸的版型，說點小心得，新年有個新開始，養成一個好習慣。

永遠加上 ";"

<?php print $title ?> 
<?php print $title; ?> // 好一點

PHP 程式碼不要與 HTML 混合

一般寫法：

<?php 
  print '<h1 class="title">' . $title . '</h1>';
?>

更好寫法：

<h1 class="title">
<?php print $title; ?>
</h1>

Comments 註釋方法

一般：

<!--
<h1 class="title">
Content
</h1>
-->

更好：

<?php 
/*
<h1 class="title">
Content
</h1>
*/
?>

使用 PHP 註釋，不會將無用的程式碼輸出到客戶端，更不會將 COMMENT 掉的重要程式碼告訴別人。

if-else

<?php if($var){ ?>
Content
<?php } ?>

更清晰：

<?php if($var): ?>
content
<?php endif; ?>

while, for 也一樣，可參考：http://www.php.net/manual/control-structures.alternative-syntax.php

一大堆 if-else，或常用的共同元素，可以在 template.php 透過 Template Preprocess 來定義一個新變量，或以分開儲存於不同檔案中。