2015-10-22 3 views
1

В C# вы можете добавлять комментарии с тегами XML. Visual studio будет использовать комментарии внутри своего автозаполнения, чтобы вы увидели хороший обзор метода.C# Documenting in non XML

///<summary> 
///summary description 
///</summary> 
public void Method1() { } 

Я нахожу вышеуказанный способ немного подробным ... Кажется, есть и другой способ. Я видел, как это использовалось внутри Unity 3D Engine. Но когда я пытаюсь скопировать его, Visual Studio не будет автоматически заполняться информацией, предоставленной внутри блока комментариев. Вот как это делает Unity:

// 
// Summary: 
//  /// 
//  summary description 
//  /// 
public void Method1() 

Кто-нибудь знает, почему вышеуказанный «код» не работает?

+0

Потому что это просто Единство, которое его принимает ... – Gusman

+0

Где вы видите комментарии в этом единстве? Вы нажимаете «Перейти к определению» по методу и просматриваете «представление метаданных» функции? –

+0

@ScottChamberlain Действительно – Faas

ответ

3

В метаданных вы не просматриваете фактический код. То, что он делает, это чтение библиотеки DLL и построение текста для отображения в метаданных.

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