PHP 嚴以律己的程式設計


分類

建立時間: 2023年10月5日 14:53
更新時間: 2024年2月15日 13:56

說明

雖然如何撰寫優良的程式碼沒有標準答案,但根據大家的經驗分享,仍然有一些值得學習的地方,我將分享我一直遵守的開發習慣給大家。

嚴格模式

PHP 是一種弱型別語言,但是你可以自己宣告要求程式啟動嚴格模式。

<?php
declare(strict_types=1);

function sum(int $a, int $b) {
    return $a + $b;
}

var_dump(sum(1, 2));
var_dump(sum(1.5, 2.5));

如上啟動 strict_types=1 之後,sum() 函式如果帶入非整數就會報錯。

在建立新檔的時候就用嚴格模式很好,但如果檔案已經存在大量的程式碼了,這時可以考慮不用加上,因為這可能會浪費很多時間在重構上面,你可能會因為一個檔案啟動嚴格模式,而需要修改數個其他檔案的程式碼。

官方文件說明: https://www.php.net/manual/en/language.types.declarations.php

PSR

PSR(PHP Standards Recommendations) 就是 PHP 標準建議,是由 PHP-FIG(PHP Framework Interop Group) 提出,我最主要用來遵守 Coding Styles 編碼風格,就是變數命名風格,還是這邊要空幾格等等的,PSR 不只建議編碼風格還有很多建議,基本上遵守他們的建議你可以暢行無阻,大部分的編輯器在進行格式化檔案的時候,都會提供 PSR 風格的格式化選擇,除非你的個性是我命由我不由天,不然跟著大家建議走十之八九不會錯。

PSR 官網: https://www.php-fig.org

PHPDoc

你可以把這個當作是 PHP 標準註解文件規範,比起自己的簡易註解說明,使用標準註解有助於其他應用程式處理其他工作,例如: 幫助編輯器辨識程式碼,自動生成文件,甚至是測試程式碼。

前往 https://docs.phpdoc.org 了解如何自動生成文件,而這也是學習標準註解文件的地方,你可以從
https://docs.phpdoc.org/guide/getting-started/what-is-a-docblock.html#what-is-a-docblock 起步。

打開語法檢查器

像 Visual Studio Code 的擴充 SonarLint 就有支援 PHP 語法檢查,在發生錯誤之前就先被解決,並且還可能能得到一些開發建議。

觀看次數: 523
linterphpphpdocpsrstricttype嚴以律己

相關文章:

按讚追蹤 Enjoy 軟體 Facebook 粉絲專頁
每週分享資訊技術

一杯咖啡的力量,勝過千言萬語的感謝。

支持我一杯咖啡,讓我繼續創作優質內容,與您分享更多知識與樂趣!