Как написать расширение Visual Studio для генерации кода?

Question

[Роман Кофф]

Как написать расширение Visual Studio, чтобы для класса в его summary формировался список его методов.
Если код проекта валидный, как расширению получить список методов текущего редактируемого класса?
Например, есть класс:

public class Test : List<string>
{
	public new void Add(string name)
	{
		base.Add(name);
	}
	public new void Remove(string name)
	{
		base.Remove(name);
	}
	public void Write()
	{
		foreach (var item in this)
			Console.WriteLine(item);
	}
}

После выполнения расширения перед строкой названия класса должен добавится текст:

/// <summary>
/// void Add(string name)
/// void Remove(string name)
/// void Write()
/// </summary>
public class Test : List<string>
{

Comments

[edward_freedom]

для чего это понадобилось?

[Роман Кофф]

Чтобы удобнее с кодом работать было. А вообще, хочу освоить технологию.

[Владимир Коротенко]

Роман Кофф, Ой ой. Что то мне кажется вы пошли не по той дороге.
Смотрите у меня в некоторых классах штук по 80 методов, представьте портянка кода будет, причем абсолютно не информативная. Поставьте лучше галочку в проекте что бы выдавал предупреждение на отсутствие комментов.
А инфу генерируйте да хоть Soundcastle, Будет приятно и по делу.

[Роман Кофф]

Вы, наверное, имели ввиду Sandcastle Help File Builder? (https://github.com/EWSoftware/SHFB)
Это тоже да, но сейчас интересна технология расширения IDE, а не решение конкретной задачи...

У меня в проектах тоже есть классы с кучей методов, но, для меня, все равно быстрее и нагляднее глянуть в заголовок класса и понять что там, чем лезть в документацию (которую, таки да, нужно будет еще и заполнить))))

Конечно, нужно стремится к формированию полноценного справочного описания проекта, так же, как к полному покрытию тестами, но на практике, часто нужно сделать просто и быстро (тем более, если код используешь только сам). Пока, для меня, это самый простой и наглядный вариант. Например, открыл класс и сразу видно что в нем:

/// <summary>
/// string GetString(this bool value, string trueText, string falseText = null)
/// string GetString(this int? value, string format = null)
/// string GetString(this long? value, string format = null)
/// string GetString(this double? value, string format = null)
/// string GetString(this float? value, string format = null)
/// string GetString(this decimal? value, string format = null)
/// string GetString(this DateTime? value, string format = null)
/// </summary>
public static partial class _e

Просто задалбывает каждый раз вручную обновлять аннотации...

Answer 1

[Maksim Tsisar]

Если подходит вариант, сделать класс partial и summary добавлять в отдельном генерируемом файле, то рекомендую не заморачиваться с расширением, а использовать Text Template Transformation Toolkit (T4) для генерации
https://habr.com/ru/post/64895/
https://docs.microsoft.com/ru-ru/visualstudio/mode...

Для получения списка методов класса используйте рефлексию
https://metanit.com/sharp/tutorial/14.1.php

Comments

[Роман Кофф]

Речь про генерацию кода во время написания кода. Это что-то типа сниппета. При редактировании класса нажимаем кнопку в IDE или комбинацию клавиш и в начало класса добавляется список его методов.

Это как функция «Remove and Sort Usings», которая в коде класса сортирует подключения usings и удаляет неиспользуемые.

[Maksim Tsisar]

Вот в закладках у себя нашел статью по написанию расширений. Правда она древняя, но не думаю, что кардинально изменился подход, может поможет
https://habr.com/ru/post/164973/

Ну и само собой дока MS
https://docs.microsoft.com/uk-ua/visualstudio/exte...

[Роман Кофф]

Очень похоже на правду. Спасибо. EnvDTE.DTE — знакомая конструкция. Теперь понятно куда копать.