Yorum ekleme
- Git kursu
- Orta seviye
- Ders 58/82
- 4 dk
PR'ya satır yorumu eklemeyi öğrenirsin.
Satır yorumu nedir?
GitHub Pull Request incelemesinde belirli bir kod satırına doğrudan yorum ekleyebilirsin. Bu yorum yalnızca genel bir mesaj değildir; ilgili satırla bağlantılı olduğu için sorunun nerede bulunduğunu açıkça gösterir.
function divide(a, b) {
return a / b;
}Örneğin sıfıra bölme ihtimalini fark ettiğinde doğrudan return a / b; satırına yorum bırakabilirsin.
Yorum ve öneri eklemek
Satır yorumunda sorunu açıklayabilir ve kodun nasıl değiştirilmesi gerektiğini önerebilirsin. GitHub, desteklenen inceleme arayüzünde önerilen kod değişikliklerini doğrudan uygulamaya imkân veren suggestion özelliğini de sunar.
// Önerilen kontrol
if (b === 0) {
throw new Error("Sıfıra bölünemez");
}Yorum yazarken kısa, anlaşılır ve çözüm odaklı olmaya dikkat et.
Uygulama Satır yorumu verisi oluştur
comment adlı nesneyi oluştur. line değerini 8, type değerini "inline" ve suggestion değerini "Add validation" yap. console.log ile öneriyi yazdır.
Başlangıç kodu
const comment = {
// Yorum bilgilerini ekle
};
// Öneriyi yazdırÖrnek çözüm
const comment = {
line: 8,
type: "inline",
suggestion: "Add validation"
};
console.log(comment.suggestion);Beklenen çıktı
Add validation
Soru ve cevaplar
Dersin sorularını cevaplarıyla birlikte inceleyebilirsin. Kendini denemek istersen dersi interaktif olarak çöz.
1 Bir kod satırına doğrudan geri bildirim vermek için hangi yorum türü kullanılır?
- Commit mesajı
- Depo açıklaması
- Satır içi yorum Doğru cevap
- Genel PR açıklaması
Açıklama: Satır içi yorum, Pull Request içindeki belirli bir kod satırına bağlanır.
2 Yorum türünü belirt
const comment = {
line: 12,
type: "____"
};const comment = {
line: 12,
type: "inline"
};Açıklama: Belirli bir kod satırına bağlı yorumun türü inline olarak adlandırılır.
3 PR yorum özellikleri
| Kavram | Anlamı |
|---|---|
Inline |
Belirli satıra bağlı |
Comment |
Geri bildirim mesajı |
Suggestion |
Önerilen kod değişikliği |
Line |
Kod satırı |