Referans yorumlarınıza eklemekle ilgileniyorsanız XML kodu, rehberlik için bu adım adım öğreticiyi kullanın. Bu işlevi nasıl çalıştıracağınızı sadece beş dakika içinde öğrenebilirsiniz. İşlemi tamamlamak kolay olsa da, başlamadan önce XML yorumları ve bunların kullanışlılığı hakkında bazı temel bilgileri bilmeniz gerekir.
XML Yorumları Neden Yararlıdır?
Her ikisi de aynı sözdizimine sahip olduğundan, XML'deki yorumlar HTML'deki yorumlarla neredeyse aynıdır. Yorumları kullanma yıllar önce yazdığınız kodu anlamanızı sağlar. Ayrıca, geliştirdiğiniz kodu gözden geçiren başka bir geliştiricinin yazdıklarınızı anlamasına yardımcı olabilir. Kısacası, bu yorumlar kod için bağlam sağlar.
Yorumlarla kolayca bir not bırakabilir veya bir XML kodunun bir kısmını geçici olarak kaldırabilirsiniz. XML "kendi kendini tanımlayan veri" olarak tasarlanmış olsa da, bazen bir XML yorumu bırakmanız gerekebilir.
Başlarken
Yorum etiketleri iki kısımdan oluşur: yorumu başlatan kısım ve yorumu bitiren kısım. Başlamak için yorum etiketinin ilk bölümünü ekleyin:
Sonra istediğiniz yorumu yazın. Yorumları diğer yorumların içine yerleştirmediğinizden emin olun (daha fazla ayrıntı için ipuçlarına bakın). Bundan sonra, yorum etiketini kapatacaksınız:
-->
Faydalı ipuçları
XML kodunuza referans yorumları eklerken, bunların belgenizin en üstüne gelemeyeceklerini unutmayın. XML'de yalnızca XML bildirimi önce gelebilir:
Yukarıda belirtildiği gibi, yorumlar iç içe geçmeyebilir. Bir saniye açmadan önce ilk yorumunuzu kapatmalısınız. Ayrıca, etiketler içinde yorumlar yapılamaz, ör.
.
İki tireyi (--) asla yorumlarınızın başında ve sonunda kullanmayın. Yorumlardaki herhangi bir şey, kullanıcılar tarafından etkin bir şekilde görünmez XML ayrıştırıcı, bu yüzden geriye kalanların hala geçerli ve iyi biçimlendirilmiş olmasına çok dikkat edin.
Toplama
XML koduna referans yorumları ekleme konusunda hâlâ sorularınız varsa, size sürecin nasıl çalıştığına dair ayrıntılı bir resim vermek için bir kitap okumak isteyebilirsiniz. gibi kitaplarRod Stephens tarafından "C# 5.0 Programcı Referansı" yardımcı olabilir.