В C# я написал XML комментарий для main метода:Комментарий XML для метода main?
/// <summary>
/// Some comment.
/// </summary>
public static void Main(string[] args)
{
Но Visual Studio предупреждает меня против него:
XML comment is not placed on a valid language element main
Что такое рекомендуемый способ прокомментировать метод main в C# ?
Некоторым языковым элементам не разрешается иметь документацию xml, такую как пространства имен и, очевидно, в этом случае также основные методы. Documentation говорит об этом, а также имеет некоторые ссылки, которые показывают другие действия XML и не делают этого.
Единственный хакерский ответ, который я мог бы предложить, - это если вы хотите прокомментировать его, просто используйте двойные кавычки // вместо троек. Тройки обрабатываются в документацию для класса и, вероятно, вызывают проблемы с фоном.
Думаю, вам нужно разместить комментарии и для параметров.
/// <summary>
///
/// </summary>
/// <param name="args"></param>
static void Main(string[] args)
{
Я думаю, что это то, что ищет VS. После написания метода просто введите /// над методом. По крайней мере, это не дает никаких ошибок/предупреждений в моей Visual Studio.
Надеюсь, это поможет.
Я хотел бы добавить предложение. Перейдите к объекту проекта -> Постройте, а затем отметьте флажок, в котором указывается файл документации XML, прежде чем начинать писать документацию по XML. Это поможет вам при написании тегов XML. Если вы поместите недопустимый тег XML, скажем, над пространством имен, тогда VS предложит указать: комментарий XML не помещается на действительный элемент языка.
он отлично работает для меня в VS2008 и VS 2010 с 0 ошибкой 0 предупреждений и 0 сообщений! где вы получаете это сообщение: «Комментарий XML не помещается в действительный элемент языка main» –
Некоторые элементы языка не вслух имеют документацию xml, такую как пространства имен и, очевидно, в этом случае также основные методы. http://msdn.microsoft.com/en-us/library/d3x6ez1z(v=vs.90).aspx Я бы предложил, если вы хотите прокомментировать это, просто используйте двойные кавычки // –
@SanjeevRai: ошибка появляется в 'Error list 'окна Visual Studio 2010 Professional. –