Neden Roslyn takımı DocumentationComment öğesini

Question

olarak işaretledi Roslyn CTP'den en son Roslyn sürümüne geçiş yapmaya çalışıyoruz. Ancak DocumentationProvider mantığını güncelledikleri görülüyor. CTP'de bu sağlayıcı tarafından iade edilen DocumentationComment sınıfını kullandı. Bu sınıf bu özelliklerle yeni özelliklerle geliştirilmiş olan Roslyn DocumentationComment sınıfın yeni sürümünde

public string FullXmlFragmentOpt { get; private set; } 

public string ExampleTextOpt { get; private set; } 

public string SummaryTextOpt { get; private set; } 

public string ReturnsTextOpt { get; private set; } 

için xml ayrıştırma için yararlı mantığı vardır, ancak her nasılsa internal olarak işaretlendi. Ve şimdi DocumentationProvider sadece XML içeriğiyle dolu dizeyi döndürür. Ve DocumentationComment bir iç sınıf olduğu için - bunu kullanamıyoruz.

Roslyn ekibinin bunu yapmasının bir sebebi var mı? Ya da belki bir sonraki sürümde geri dönecekler mi?

Answer 1

DocumentationComment sınıfı derleyici katmanından dışarı taşındı ve iç yapısını oluşturdu çünkü iç ve dış görünüme kavuşturulduğundan dolayı, tüm ayrıntıları bir belge yorumunda açıklamanın yetersiz olduğu belirlendi, çünkü bu, göründü ve atla gibi diğer parçaları içeriyordu ve aslında herhangi bir istediğin diğer xml etiketi. Genel API'nin bir parçası olarak mantıklı olan tek yapı, bir xml okuyucu veya DOM'ı kullanarak onu ayırmak için kullanabileceğiniz bir xml dizesiydi. Artık olduğu gibi, DocumentationComment sınıfı tek bir Roslyn özelliğinin uygulama ayrıntısıdır.

Açık kaynak olduğu için kodu kopyalayarak dilerseniz kullanabilirsiniz. Gerçek iç sınıf değişebilir ve hatta silinebilir