Cevabı elbette birçok faktöre bağlı olabilir, ancak doğru, iyi biçimlendirilmiş düz metin koduyla başlarsak , burada az çok genel şeyler olabilir.
Kaynak metindeki ilk 'biçimlendirme':
satırsonu , boşluk ve sekme karakterleri olacaktır. Yeni hat ve (DTP yazılımında olduğu gibi) manuel satır sonu aynı şey değildir ve bunun tersi, bazı nadir diller geldiğini hatırlatırız olabilir
böyle duymadım rağmen, diğer biçimlendirme karakterlerini tanır.
Yorumlar kodun yürütülebilir bir parçası değildir, bu yüzden gerçekten bir yorum olup olmadığını biliyorsanız, bunlar çok fazla risk olmadan yeniden biçimlendirilebilir. Bu yüzden bakmanız gereken ilk şey yorumların nasıl etiketlendiğidir.
İlk düz metin biçimlendirmesiyle ilgili bazı temel bilgileri bilmek iyidir. Örneğin, Python için PEP8 stil rehberi vardır . Python için yapılmış olsa da, bu biçimlendirme kılavuzu C / C ++ ve Java gibi büyük diller için referans olarak kullanılabilir. Şüphe duyduğunuzda çeşitli örnek projelere bakmak yardımcı olabilir.
Böylece, ilk ilke şöyle olacaktır: Kaynak metni değiştirmeyin.
Bir kontrol listesi üzerinden gitmek istiyorum - emin olun:
- Hiçbir sahnede karakter otomatik kaydetme gerçekleşmez.
- Metinde hiçbir düzenleme yapılmaz (yapılması gerektiğinden% 100 emin değilseniz).
- Satır kaydırma görünmüyor.
- Girintiler görsel olarak korunur ve tutarlıdır ( girinti seviyesi başına yaklaşık dört x genişlik).
- Başlangıç (sıfır) girinti seviyesi görünür olmalıdır.
- Tanımlı stiller sözdiziminin biçimlendirmesini yok etmez (sözdizimi vurgulama kullanılıyorsa).
- Orijinal biçimlendirmeyi yeniden kontrol edebilmek veya yeniden başlatabilmek için kaynağın düz metin olarak yedeğini alın.
- Varsa, satır numaraları özellikle açıklamalarda referans gösteriliyorsa bozulmamış olmalıdır.
Aslında orijinal kaynak düzgün biçimlendirilmişse, hiçbir satır kaydırması olmamalıdır. Sarılmış çizgiler hala görünüyorsa ve kaçınılmazsa, tek düzey asılı girinti en yaygın çözümdür (yukarıdaki bağlantılı PEP'e bakın). Satır kesilmesi gerekiyorsa - stil kılavuzuna veya yazara başvurun.
Yine de bazı küçük 'beyaz boşluk' karakterlerinin değiştirilmesi gerekebilir. Kaynak sekme karakterleri içerebileceğinden, bu elbette dizelleştiricinin her satırın başındaki tüm sekmelerin tutarlı olmasını sağlamalıdır, yani iç içe girintiler görsel olarak korunur ve her girintinin her bir seviyesi aynı genişlikte olmalıdır (yaklaşık dört x bir girinti seviyesi başına genişlik).
İdeal olarak, boşluk karakterleri veya karışık boşluklar ve sekmelerle yapılan girintiler tablo ile (veya DTP yazılımının iç içe girintiler için daha iyi yapabileceği şeyle) değiştirilmelidir, bu nedenle gerekirse girintileri ayarlamak daha kolay olabilir.
Tabii ki boşluk bırakılabilir, ancak yazı tipini değiştirirken genişliklerini yönetmek daha zor olabilir ve tablo sütunlarında olduğu gibi iç çizgi girintilerini hizalamak daha zor olabilir.
Eş aralıklı yazı tipi + boşluklar
Kaynak kasıtlı olarak boşluklarla biçimlendirilmişse ve yalnızca tek aralıklı yazı tipinde okunması amaçlanmışsa (örneğin ASCII diyagramları veya ASCII-art) boşlukların tamamen değişmeden korunması gerektiğini , ancak bu kararın en baştan yapılması gerektiğini unutmayın. "Courier New" yazı tipi bu durumda en yaygın olanıdır. Yine de gerçekten ihtiyaç duyulmuyorsa, tek aralıklılara karşı öneriyorum, çünkü daha az yeni insan bugün kodlama için tek aralıklı seçiyor ve düzeltme okuma durumunda, orantılı yazı tipleri daha iyi okuma deneyimi sağlayacak.
Genel olarak, kısaltılmış (örn. Arial dar) veya daha küçük yazı tipleri daha iyi çalışabilir: gövde metninin aksine daha fazla vurgu yapar, kodu daha kompakt hale getirir ve böylece istenmeyen satır sarmanın ortaya çıkması daha az olasıdır.
Bence bir çizgi çizebilir ve yukarıdakiler yapılırsa, en azından renksiz düz bir tek yazı tipi kod bloğu için her şeyin iyi olması olasılığı% 99 olabilir.
Araçlar ve gelişmiş biçimlendirme
Ayrıca, sözdizimi vurgulaması kullanılarak görünüm önemli ölçüde geliştirilebilir.
renkli baskı veya ekran görüntüleme: tam renkli bir düzende vurgulamanın her özelliği kullanılabilir, bu nedenle en iyi senaryodur, ancak yazdırma bazı renk değişikliklerine neden olabilir.
gri tonlamalı veya s / b baskı: burada elbette kalın (örn. anahtar kelimeler) veya italik (örn. yorumlar) kullanılabilir, ancak renklerin tüm sonuçlarla griye dönüştürüleceğini unutmayın. Örneğin gri renkli yorumlar ekranda harika görünebilir, ancak kağıt üzerinde çok soluk olabilir.
En önemli soru, düzenleyicinin kodu okunabilir bir biçimde temsil edebilecek araçlara sahip olup olmadığıdır. Neyse ki, kod düzenleme için bir çok ücretsiz araç var, en göze çarpan (Windows için): Notepad ++, VSCode, Visual Studio . Ancak sekmelerin boşluklara örtülü olarak otomatik dönüştürülmesinin farkında olun.
Notepad ++ uygulamasında , kodu tüm biçimlendirme ve sözdizimi vurgulamasını koruyacak şekilde RTF olarak dışa aktarma seçeneği vardır .
Düzen, kod sunumundaki metin akışının değiştirilmesini gerektirmiyorsa, görüntüler doğrudan kullanılabilir (ekran görüntüleri) - metin kadar esnek değildir, ancak% 100 biçimlendirme ve satır numaralandırmasını koruyacaktır ve çok zaman kazandırabilir. Örneğin, satır numaralarının metin biçiminde korunması zor olabilir. Ayrıca PDF'ye dışa aktarma iyi bir alternatiftir - ancak tüm DTP yazılımları PDF'leri gömemez ve PDF'ye yazdırırken bazı biçimlendirme kaybolabilir.
Örneğin, Notepad ++ içindeki Python kodu için kurulumum şöyle:
Bu sadece bir kişinin ekran görüntülerini doğrudan kullanabileceğini ve aslında en kolay yöntem olabileceğini göstermek içindir. Ekran yakalamaya yardımcı olabilecek çeşitli araçlar vardır - daha yüksek çözünürlüklü görüntüler için ekranların 'dikilmesi' gerekebilir.
Renk şeması, elbette, desteklenen dilin zaten farkında olan editörün stil konfigürasyonunda tanımlanan bireyseldir, böylece sözdizimini bilmese bile yanlış biçimlendirme yapmayı zorlaştırır. Burada genel tipografi kuralları çalışmalıdır: çok fazla renk, tutarlı yazı tipleri, girintiler, rahat satır aralığı.
Özel dil tanımları için ek araçlar / eklentiler de yaygındır, ancak sözdizimi bilgisi gerektirir.