Rehber Forum mesajında kod, hata metni ve dosya örneği nasıl paylaşılır?

[Garfield]

Kod veya hata metnini forumda paylaşırken, başkalarının satır yapısını bozmadan okuyup sorunun yerini bulabilmesini hedefleyin. Kod için kod bloğu, açıklama için normal paragraf, gerekli dosya için de temizlenmiş küçük bir örnek kullanın. Her şeyi tek ekran görüntüsüne sıkıştırmak, özellikle uzun hatalarda incelemeyi zorlaştırır.

Kod ile açıklamayı birbirinden ayırın​

Kodun ne yaptığını ve nerede çalıştırdığınızı önce bir iki cümleyle anlatın. Ardından sorunla ilgili en küçük kod parçasını ekleyin. Yalnız hatalı satırın verilmesi bazen yeterli olmaz; o satıra gelen değişkenin nasıl oluşturulduğu veya hangi dosyanın okunduğu da gerekebilir.

Bütün projeyi mesajın içine koymak yerine, eksik parçanın sorunu açıklamaya etkisini düşünün. Bir dosya okuma hatasında dosya yolu ve çalışma dizini önemlidir; sayfanın tasarım CSS'si ise çoğu zaman konu dışıdır. Bu seçim, yardım edecek kişinin gereksiz kod arasında hata aramasını azaltır.

Okunabilir bir örnek oluşturun​

1. Kullandığınız dil, uygulama ve ilgili sürüm bilgisini yazın. Sürümü bilmiyorsanız uygulamanın sürüm alanından veya uygun sürüm komutundan kontrol edin; tahminî bir sayı yazmayın.
2. Çalışan örneğin kopyasında özel değerleri değiştirin. Anahtar, parola ve gerçek müşteri verisi yerine açıkça temsili yer tutucular kullanın.
3. Editörün kod ekleme aracını kullanarak kodu bir kod bloğuna yerleştirin. Dil seçeneği varsa örneğe uygun dili seçin. Hata metnini ayrı bir blokta vermek, kod ile çıktının karışmasını önler.
4. Önizlemede girintileri ve satır sonlarını kontrol edin. Bir tırnağın, ters eğik çizginin veya işaretin eksilmesi örneğin anlamını değiştirebilir.
5. Gönderdikten sonra mesajdaki kodu düz metin olarak kopyalayıp kendi örneğinizle karşılaştırın. Ekranda doğru görünmesi, kopyalanabilir içeriğin de doğru kaldığını tek başına kanıtlamaz.

Küçük bir destek örneği​

Şu açıklama, yalnız “Python dosyamı bulmuyor” demekten daha kullanışlıdır: “Bu kodu proje klasöründe çalıştırıyorum. Örnek dosyam aynı klasörde, fakat uygulamayı farklı bir dizinden başlatınca hata oluşuyor.”

from pathlib import Path

path = Path("ornek.txt")
print("Calisma dizini:", Path.cwd())
print("Dosya bulundu mu:", path.exists())

Bu örnek dosyayı değiştirmez; yalnız çalışma dizinini ve belirtilen göreli yolun bulunup bulunmadığını gösterir. Sonuçta dosya bulunmuyorsa gerçek klasör düzeninizi özel kullanıcı adlarını temizleyerek açıklayabilirsiniz. Bu, dosyanın içeriğini paylaşmadan yol sorununu incelemeye yardımcı olur.

Dosya gerekiyorsa ne eklenmeli?​

Sorunu üreten küçük dosyayı ve onu açmak için gereken kısa açıklamayı ekleyin. Çalıştırılabilir dosya yerine incelenebilir kaynak örneği tercih etmek değerlendirmeyi kolaylaştırır. Bir bağlantı paylaşıyorsanız hangi dosyayı içerdiğini ve okurun onu neden açması gerektiğini belirtin. Forumun ek dosya seçeneği görünmüyorsa, izinleri aşmaya çalışmak yerine dosya türünü ve ihtiyacınızı konu içinde açıklayın.

 

[YerelCekirdek]

Örnek dosya yolundaki kullanıcı adını gizlemek anlaşılır, fakat yolun tamamını değiştirmek hatayı da gizleyebilir mi? Özellikle göreli yol ile çalışma klasörü ilişkisini korumak gerekiyor gibi görünüyor. Dosya bulunamadı sorununu paylaşırken hangi kısmı temsili bırakmak daha yararlı olur?

 

[MetinAtolyesi]

Örnekte klasörlerin birbirine göre konumunu koruyup özel adları değiştirmek iyi bir başlangıç olur. Kullanıcı adını “ornek_kullanici” yapabilirsiniz; dosyanın üst klasörde mi aynı klasörde mi olduğunu değiştirmeyin. Çalışma dizini bilgisini ve kullandığınız göreli yolu ayrı vermek, dosyanın içeriğini açmadan ilişkiyi incelemeyi sağlar.

 

[KodKutuphanesi]

Yalnız göreli yol örneği de her durumda yeterli olmayabilir. Sorun belirli bir mutlak yol, boşluk veya Türkçe karakterle ilgiliyse bunu tamamen sadeleştirmek nedeni ortadan kaldırabilir. Özel adı gizlerken karakter türünü ve klasör yapısını korumak, hangi dönüşümün hatayı değiştirdiğini de belirtmek daha açıklayıcı olur.