Member 11579819 Ответов: 2

Как добавить резюме в файл класса с помощью внешнего документа

Можно ли это сделать с помощью внешнего файла:

/// <summary>
        /// Set the box header 
        /// </summary>
        [DataMember]
        public bool HasHeader { get; set; }


Что я уже пробовал:

Мне нужно сделать все вышесказанное с помощью внешнего файла.

Suvendu Shekhar Giri

Почему вы хотите это сделать?
Какова логика, с помощью которой это будет сделано?

Member 11579819

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

Suvendu Shekhar Giri

Это нормально, но должна быть какая-то логика, на основе которой вы будете вставлять xml-комментарии в соответствующий метод/класс и т. д., Не так ли?

Я слышал о создании документации из xml-комментариев в вашем коде, но не уверен, что это возможно.

Member 11579819

Создание документации в коде уже есть в моем проекте. Теперь мне нужно сделать это с помощью внешнего документа. Это похоже на задание РНД, возложенное на меня. Поэтому я решил задать этот вопрос здесь, так как я всегда получал свое решение всякий раз, когда отправлял какой-либо вопрос. И никакой логики мне не дано. Просто мне нужно сделать рнд и посмотреть, возможно ли это.

Suvendu Shekhar Giri

опять же, можете ли вы показать внешний файл, как он выглядит, если он у вас уже есть?

Member 11579819

Нет... я еще ничего не начинал. И все же я ищу решение

2 Ответов

Рейтинг:
4

Foothill

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

Кроме того, в разделе параметры проекта VS: Build- & gt;Output- & gt;(check) XML Documentation file
Это позволит написать XML-файл документации, когда вы создадите свой код из ваших комментариев. Затем XML может быть использован другими инструментами, такими как Sandcastle, для создания богатой документации для вашего клиента.

Рейтинг:
14

#realJSOP

Единственный реальный способ добавить XML-комментарии к вашему коду-это сделать это вручную. Существует вспомогательное расширение, доступное для Visual Studio, называемое GhostDoc. Это помогает немного облегчить боль.

Конечно, вы можете написать приложение, чтобы сделать это за вас, но это займет гораздо меньше времени, чем ручное комментирование кода, чем разработка, тестирование и отладка приложения.

Конечно,все это было бы спорным, если бы вы просто комментировали, а не откладывали.

Наконец, ваш клиент хочет этого, потому что, когда он нанимает кого-то другого для поддержки вашего кода, он хочет, чтобы код был достаточно хорошо документирован.