- Kod Kalitesi:
- Mantıklı ve Anlaşılır Kod: Kodun mantıklı, okunabilir ve anlaşılır olması önemlidir. Değişken ve fonksiyon isimleri açıklayıcı olmalıdır.
- Kod Tekrarı (Duplication): Gereksiz kod tekrarlarından kaçınılmalıdır.
// Örnek
// İyi
$total = $price * $quantity;
// Kötü
$total = $price + $price + $price; // Tekrarlı kod
- Standartlara Uygunluk:
- Proje Standartları: Projede belirlenen kodlama standartlarına uyulmalıdır.
- PSR Standartları: Eğer projeniz PSR standartlarına uyuyorsa, bu standartlara uygunluğa özellikle dikkat edilmelidir.
- Performans:
- Optimizasyon: Performansı etkileyebilecek gereksiz döngüler, sorgular veya diğer işlemler kontrol edilmelidir.
// Örnek
// İyi
$users = User::with('posts')->get();
// Kötü
$users = User::all();
foreach ($users as $user) {
$user->load('posts');
}
- Güvenlik:
- SQL Injection ve XSS Koruma: Giriş verileri uygun şekilde işlenmeli ve güvenlik açıklarına karşı önlem alınmalıdır.
// Örnek
// İyi
$name = $request->input('name');
$user = DB::select("SELECT * FROM users WHERE name = ?", [$name]);
// Kötü
$name = $request->input('name');
$user = DB::select("SELECT * FROM users WHERE name = '$name'"); // SQL Injection riski
- Verimli ve İdareli Kod:
- Efektif Kullanım: API’ları, kütüphaneleri ve dilin özelliklerini etkili bir şekilde kullanma.
// Örnek
// İyi
$users = User::whereIn('id', [1, 2, 3])->get();
// Kötü
$users = User::find(1);
$users = $users->merge(User::find(2));
$users = $users->merge(User::find(3)); // Daha fazla sorgu çağrısı
- Test Edilebilirlik:
- Test Edilebilir Kod: Kodun test edilebilir olması, hataların erken tespiti ve güvenilir yazılım geliştirmesi açısından önemlidir.
// Örnek
// İyi
class Calculator {
public function add($a, $b) {
return $a + $b;
}
}
// Kötü
function add($a, $b) {
return $a + $b;
}
- Yorum ve Dokümantasyon:
- Açıklamalar: Karmaşık veya özel bir durumu açıklayan yorumlar eklenmelidir.
- Fonksiyon ve Sınıflar: Fonksiyonlar ve sınıflar hakkında belgeleme eklenmelidir.
// Örnek
// İyi
/**
* Bu fonksiyon iki sayıyı toplar.
*
* @param int $a
* @param int $b
* @return int
*/
function add($a, $b) {
return $a + $b;
}
// Kötü
function add($a, $b) {
return $a + $b;
}
- İsimlendirme:
- Açıklayıcı İsimler: Değişken ve fonksiyon isimleri açıklayıcı olmalıdır.
- Magic Numbers: Direkt sayılar yerine, anlamı ifade eden sabitler veya değişkenler kullanılmalıdır.
// Örnek
// İyi
const MAX_ATTEMPTS = 3;
for ($i = 0; $i < MAX_ATTEMPTS; $i++) {
// ...
}
// Kötü
for ($i = 0; $i < 3; $i++) {
// ...
}
Bu noktalar, code review sürecinde dikkate alınması gereken temel prensiplerdir. Code review, hem yazılım kalitesini artırma hem de ekip içinde bilgi paylaşımını destekleme açısından oldukça önemlidir.
İlk Yorumu Siz Yapın