2009-11-23 3 views
2

скажем, у меня есть класс А и определение B. Класс A является:.Как я могу прочитать документацию из класса в другом классе?

/// <summary> 
/// This is the class documentation. 
/// </summary> 
public class A 
{ 
    /// <summary> 
    /// This is the documentation for attribute. 
    /// </summary> 
    public int attribute; 
    ... 
} 

Я хочу, чтобы получить доступ к документации из класса А (т.е. тех строк, которые считывают «Это документация класса.» И ' Это документация для атрибута. ') В классе B программно. Есть ли способ сделать это? используя отражение, возможно?

Спасибо за вашу помощь :)

ответ

3

Я предполагаю, что вы используете визуальную студию. Перейдите в настройки своего проекта, задайте путь к файлу документации Xml. Когда вы компилируете, комментарии будут сбрасываться в файл Xml. Затем вы можете открыть файл программно и прочитать комментарии

+1

Да, это правильно. Щелкните правой кнопкой мыши по проекту, выберите свойства, а затем на вкладке «Построить» установите флажок «& XML document file:». Он должен по умолчанию указывать местоположение. Оттуда все ваши сборки должны иметь доступ к этим комментариям intellisense. – McKay

0

Генерировать файл XML документации, а затем вы можете разобрать его программно.

1

Документация не экспортируется в сборку программ. Он (необязательно) извлекается в отдельные файлы XML.

Чтобы сделать то, что вы предлагаете, вам нужно будет найти или написать инструмент, который анализирует XML-файлы и добавит метаданные в сборку, или отправит XML-файл с сборкой и погрузится в него, когда вы хотите получить связанные документация.

Смежные вопросы