2.7 KiB
Kodunuzu Yorumlayın
Talimatlar
Temiz ve iyi belgelenmiş kod, projelerinizi sürdürmek ve paylaşmak için çok önemlidir. Bu ödevde, profesyonel geliştiricilerin en önemli alışkanlıklarından birini uygulayacaksınız: kodunuzun amacını ve işlevselliğini açıklayan açık ve faydalı yorumlar yazmak.
Oyun klasörünüzdeki mevcut app.js dosyanızı gözden geçirin ve yorum ekleme ve düzenleme yolları bulun. Kodun kontrol dışına çıkması çok kolaydır, bu yüzden şimdi yorumlar ekleyerek okunabilir bir kod oluşturmak için iyi bir fırsatınız var, böylece daha sonra kullanabilirsiniz.
Göreviniz şunları içerir:
- Kodun her ana bölümünün ne yaptığını açıklayan yorumlar ekleyin
- Fonksiyonları, amaçlarını ve parametrelerini açık bir şekilde açıklayarak belgeleyin
- Kodunuzu mantıksal bloklara ayırarak bölüm başlıkları ekleyin ve düzenleyin
- Kullanılmayan veya gereksiz kodu kaldırın
- Değişkenler ve fonksiyonlar için tutarlı adlandırma kuralları kullanın
Değerlendirme Ölçütleri
| Kriter | Örnek Niteliğinde | Yeterli | Geliştirme Gerekiyor |
|---|---|---|---|
| Kod Belgelendirme | app.js kodu, tüm ana bölümler ve fonksiyonlar için açık ve faydalı açıklamalarla tamamen yorumlanmış |
app.js kodu, çoğu bölüm için temel açıklamalarla yeterince yorumlanmış |
app.js kodunda minimum yorum var ve açık açıklamalar eksik |
| Kod Düzeni | Kod, mantıksal bloklara ayrılmış, açık bölüm başlıkları ve tutarlı bir yapıya sahip | Kod, ilgili işlevselliğin temel gruplandırmasıyla biraz düzenlenmiş | Kod biraz düzensiz ve takip edilmesi zor |
| Kod Kalitesi | Tüm değişkenler ve fonksiyonlar açıklayıcı isimler kullanıyor, kullanılmayan kod yok, tutarlı kurallara uyuyor | Kodun çoğu iyi adlandırma uygulamalarını takip ediyor, minimum kullanılmayan kod var | Değişken isimleri belirsiz, kullanılmayan kod içeriyor, tutarsız stil |
Feragatname:
Bu belge, AI çeviri hizmeti Co-op Translator kullanılarak çevrilmiştir. Doğruluk için çaba göstersek de, otomatik çeviriler hata veya yanlışlıklar içerebilir. Belgenin orijinal dili, yetkili kaynak olarak kabul edilmelidir. Kritik bilgiler için profesyonel insan çevirisi önerilir. Bu çevirinin kullanımından kaynaklanan yanlış anlamalar veya yanlış yorumlamalardan sorumlu değiliz.