HTML Yorumları ve Nasıl Kullanılır?
aBir tarayıcıda bir web sayfasını görüntülediğinizde, belirli bir web sayfasının koduna bağlı olarak hangi yazılım parçasının (web tarayıcısı) görüntülendiğine ilişkin görsel bir sunum görürsünüz. Web sayfasının kaynak kodunu görüntülerseniz, paragraflar, başlıklar, listeler, bağlantılar, resimler ve daha fazlası dahil olmak üzere çeşitli HTML öğelerinden oluşan bir belge görürsünüz. Tüm bu unsurlar, web sitesi ekranının bir parçası olarak bir ziyaretçi ekranındaki tarayıcı tarafından oluşturulur. HTML kodunda bir kişinin ekranında görüntülenmeyen bir şey "HTML yorumları" olarak bilinen şeydir.
Yorum nedir?
Yorum, tarayıcı veya ayrıştırıcı tarafından görüntülenmeyen veya izlenmeyen HTML, XML veya CSS içindeki bir kod dizisidir. Kod geliştiricilerden bu kod veya diğer geri bildirimler hakkında bilgi sağlamak için basitçe kodun içine yazılır.
Çoğu programlama dilinin yorumları vardır, bunlar genellikle kod geliştiricisi tarafından aşağıdaki nedenlerden biri veya birden fazlası için kullanılır:
- Gelecekte üzerinde çalışmak zorunda kalabilecekleri karmaşık kodları açıklayınız ve açıklayınız - kendileri de dahil olmak üzere! Onlar 12 ayın 3 ya da 6'sı ya da daha geç kodlarına geri dönebilir ve neden belli bir şeyi yaptıklarını hatırlamadılar. Yorumlar, sorularına cevap vermeye ve bu sayfayı ilk geliştirirken akıllarının nerede olduğunu hatırlatmaya yardımcı olabilir.
- Kodun ne zaman düzenlendiği veya gözden geçirildiği ile ilgili ayrıntıları sağlayın. Bu yararlı bilgiler olabilir ve bir sitenin en son ne zaman çalıştığıyla ilgili bir geliştirme günlüğü gibi davranabilir.
- Kod bölümlerini kaldırın, ancak daha sonra kullanmak için bunları bırakın. Bu genellikle site testi ve hata ayıklama sırasında yapılır. Bir sitede bir sorun yaşıyorsanız ve buna neyin neden olduğundan emin değilseniz, her seferinde bölümleri bir kereye mahsus olarak yorumlayabilir ve sorunu belirleyebilir ve daha sonra yaşadığınız problemler için bir çözüm üzerinde çalışabilirsiniz.
- Kod üzerinde çalışan diğer geliştiricilerle sohbet edin. Bu, geliştirme sırasında, aynı zamanda kod üzerinde çalışan başkalarıyla ayrıntıları paylaşmanın bir yolu olarak yapılabilir. Bu yorumlar yalnızca geliştirme konuşmalarıysa, bir site kullanıma sunulmadan önce bunları koddan kaldırmak en iyi uygulamadır.
Geleneksel olarak, HTML'deki yorumlar, karmaşık tablo yapılarının açıklamalarından, sayfanın içeriğinin bilgilendirici ifadelerine kadar neredeyse tüm öğeler için kullanılır. Yorumlar bir tarayıcıda oluşturulmadığından, HTML'de herhangi bir yere ekleyebilirsiniz ve site bir müşteri tarafından görüntülendiğinde ne yapacağına dair endişeleriniz yoktur.
Yorumlar nasıl yazılır
HTML, XHTML ve XML'de yorum yazmak çok kolaydır. Yorum yapmak istediğiniz metni aşağıdakilerle basitçe çevirin:
ve ->Gördüğünüz gibi, bu yorumlar "sembolden daha az", artı bir uyarı işareti ve iki çizgi ile başlar. Yorum, iki çizgi daha ve "daha büyük: sembol." Ile biter. Bu karakterler arasında yorumun gövdesini oluşturmak istediğiniz her şeyi yazabilirsiniz.
CSS'de, HTML'den ziyade C kodu yorumlarını kullanarak biraz farklıdır. Bir yıldız işareti ile takip edilen bir eğik çizgi ile başlarsınız. Yorumu tersine, bir yıldız işareti ve ardından eğik çizgi ile bitirirsiniz.
/ * yorumlanmış metin * /Yorumlar Ölmekte Olan Bir Sanat
Çoğu programcı yararlı yorumların değerini bilir. Yorumlanan kod, bu kodun bir ekip üyesinden diğerine aktarılmasını kolaylaştırır. Yorumlar, QA ekibinin kodu test etmesine yardımcı olur, çünkü geliştiricinin neyi başardığına bile ulaşamadıklarını söyleyebilirler. Ne yazık ki, Wordpress gibi web sitesi yazma platformlarının popülaritesiyle, sizin için HTML'nin tamamını olmasa bile çok fazla işleyen seçilmiş bir temaya sahip olmanıza ve çalıştırmanıza izin veriyorsunuz, yorumlar genellikle web ekipleri tarafından kullanılmıyor. Bunun nedeni, doğrudan kodla çalışmadığınız takdirde yorumların çoğu görsel yazma aracında görülmesi çok zordur. Örneğin, bir web sayfasının en üstünde görmek yerine,
Görsel araç, bir yorumun var olduğunu göstermek için küçük bir simge gösterir. Tasarımcı, yorumu fiziksel olarak açmazsa, hiç görmeyebilir. Yukarıdaki sayfada, sayfayı düzenlediğinde sorunlara yol açabilir ve bu düzenleme, yorumda belirtilen komut dosyasının üzerine yazılır.
Ne yapılabilir?
- Anlamlı ve faydalı yorumlar yazınız. Çok uzunsa veya yardımcı bilgiler içermiyorsa diğer kişilerin yorumlarınızı okumasını beklemeyin.
- Bir geliştirici olarak, bir sayfada gördüğünüz yorumları mutlaka gözden geçirmelisiniz.
- Yazma programları tarafından sağlanan ve yorum eklemenize izin veren araçları kullanın.
- Sayfaların nasıl düzenlendiğini kontrol etmek için içerik yönetimini kullanın.
Web sayfalarınızı düzenleyen tek kişi sizseniz bile, yorumlar yararlı olabilir. Karmaşık bir sayfayı yılda bir kez düzenlerseniz, tabloyu nasıl oluşturduğunuzu veya CSS'yi nasıl oluşturduğunuzu unutmak kolaydır. Yorumlarınızda, sizin için orada yazıldığı gibi, hatırlamak zorunda değilsiniz.
Jennifer Krynin tarafından yazılmış orijinal makale. Jeremy Girard tarafından 5/5/17 tarihinde düzenlendi