Форум программистов, компьютерный форум, киберфорум
Наши страницы
C# для начинающих
Войти
Регистрация
Восстановить пароль
 
Рейтинг 4.50/4: Рейтинг темы: голосов - 4, средняя оценка - 4.50
polsok
3 / 3 / 6
Регистрация: 20.03.2011
Сообщений: 348
#1

Как документировать пространство имен

16.12.2012, 11:37. Просмотров 783. Ответов 8
Метки нет (Все метки)

C#
1
2
3
4
5
6
7
8
9
10
11
12
13
14
namespace Person
{
    /// <summary>
    /// Здесь создается объект Person
    /// </summary>
    class Person
    {
        Person_topping Object = new Person_topping();
            public Person() {}
            public int Age { get; set; }
            public string Name { get; set; }
            public string Gender { get; set; }
        }
    }
Как добавить XML комментарий к namespace Person?
0
Надоела реклама? Зарегистрируйтесь и она исчезнет полностью.
Similar
Эксперт
41792 / 34177 / 6122
Регистрация: 12.04.2006
Сообщений: 57,940
16.12.2012, 11:37
Ответы с готовыми решениями:

Как изменить пространство имен?
Накатал программку, где namespace задан по умолчанию - WindowsFormsApp1:using...

Как добавить пространство имен using System.Diagnostics
Здравствуйте, не могу понять как добавить пространство имен using...

Как правильно импортировать ссылку в проект и ее пространство имен?
Добавляю в программу ссылки на dll ссылки -&gt; добавить ссылку... -&gt; обзор.. -&gt;...

Как подключить пространство имен System.Windows.Media?
Хотел поработать с system.windows.media.animation, но не смог подключить...

Пространство имен не может непосредственно содержать такие члены, как поля или методы
int NumberOfLegs ( string animalName) { if (animalName == &quot;слон&quot;) { return...

8
n1l
135 / 137 / 18
Регистрация: 26.07.2010
Сообщений: 911
16.12.2012, 11:45 #2
Никак, это не возможно.
0
polsok
3 / 3 / 6
Регистрация: 20.03.2011
Сообщений: 348
16.12.2012, 12:01  [ТС] #3
Очень жаль(((
неужели мелкомягкие не продумали это
0
n1l
135 / 137 / 18
Регистрация: 26.07.2010
Сообщений: 911
16.12.2012, 12:05 #4
А зачем там комментарии, это вообще не нужно.
Прочитайте code convensions для .net и c#. В особенности как наименовать пространства имен и вы сами поймете, что комментарии в них - это лишнее.


C#
1
2
3
    /// <summary>
    /// Здесь создается объект Person
    /// </summary>
Кстати это в корне не правильная запись. Объект в классе не создается.
0
elp
1 / 1 / 1
Регистрация: 27.07.2013
Сообщений: 8
27.07.2013, 14:03 #5
n1l, здесь вопрос идет не о комментировании, а о документировании.
С Sandcastle Help File Builder получается не очень понятно для страницы неймспейса
0
n1l
135 / 137 / 18
Регистрация: 26.07.2010
Сообщений: 911
27.07.2013, 20:05 #6
Вы знаете что такое xml документация?
0
elp
1 / 1 / 1
Регистрация: 27.07.2013
Сообщений: 8
27.07.2013, 22:54 #7
Вот именно об этом я и спрашиваю... Можно ли написать в проекте summary для пространства имен, чтобы оно ушло в xml-документацию?
Дабы не было отсылок на code convensions и прочие первоисточники, поясню ситуацию... С помощью Sandcastle Help File Builder пытаюсь собрать из xml документацию в формате chm... При сборке SHFB выдает предупреждение Warn: ShowMissingComponent: [N:elp.Yandex.Translate] Missing <summary> documentation. Соответствующая страница namespace'a получается не очень...
0
n1l
135 / 137 / 18
Регистрация: 26.07.2010
Сообщений: 911
28.07.2013, 08:31 #8
А я об этом и говорю, что нельзя. Документация складывается из xml комментариев, специально для namespace'ов их нет. Вы можете выйти из положения другим способом, путем каких-то хитросплетений.
Например создать класс YourNamespaceDoc и в нем прокомментировать каждый тип в этом namespac'e в качестве свойства.

C#
1
2
3
4
5
6
7
8
9
10
11
   ///<summary>
   ///this namespace is just for lulz
   ///</summary>
  YourNamespaceDoc
  {
    ///<>
    ///
    ///
    public YourFirstClass YouFirstClass{get;set;}
    public YourSecondClass YouSecondClass{get;set;}
  }
0
elp
1 / 1 / 1
Регистрация: 27.07.2013
Сообщений: 8
28.07.2013, 20:30 #9
n1l, ясно Спасибо за помощь
0
28.07.2013, 20:30
MoreAnswers
Эксперт
37091 / 29110 / 5898
Регистрация: 17.06.2006
Сообщений: 43,301
28.07.2013, 20:30

Ошибка «Пространство имен не может непосредственно содержать такие члены, как поля или методы»
Добрый день! C# Visual Studio 2010 Программа выдает ошибки:...

If (i ==2) Ошибка: пространство имен не может непосредственно содержать такие члены, как поля или методы
using System; using System.Collections.Generic; using System.Linq; using...

Пространство имен не может напрямую включать в себя такие члены, как поля или методы
/* * Created by SharpDevelop. * User: Маруся * Date: 05.03.2018 * Time:...


Искать еще темы с ответами

Или воспользуйтесь поиском по форуму:
9
Ответ Создать тему
Опции темы

КиберФорум - форум программистов, компьютерный форум, программирование
Powered by vBulletin® Version 3.8.9
Copyright ©2000 - 2018, vBulletin Solutions, Inc.
Рейтинг@Mail.ru