将类描述添加到代码？

我正在完成一个我一直在努力的项目，并且刚刚进行了最后的调整。将类描述添加到代码？

我想要做的一件事就是在每个类文件的顶部添加类描述（以帮助自己和其他程序员弄清楚发生了什么）。我的想法是用一堆'/'来为我写一些笔记，但也许有更好的方法？在Visual Studio中有内置的方法吗？

///////////////////////////////////////////////////// 
//             // 
// KillZombies.cs         // 
//             // 
// Description: This class contains blah blah blah // 
//             // 
/////////////////////////////////////////////////////

来源

2010-07-12 sooprise

是的，你应该使用正常XML documentation：

/// <summary> 
/// Describe your class quickly here. 
/// </summary> 
/// <remarks> 
/// Add more details here. 
/// </remarks>

这样，它会在智能感知显示，如果你建立与沙堡/ NDoc的你的文档/ Doxygen的等也将相应地出现。

如果您在类上方的行中键入“///”，则应该看到适当的模板以开始使用。有关更多信息，请参阅上面的MSDN链接。

来源

2010-07-12 14:20:29

非常好。我使用“///”来描述我的方法，但不知道它是否适合整个类。 – sooprise 2010-07-12 15:13:45

使用XML documentation comments：

/// <summary> 
/// This class performs an important function. 
/// </summary>

当你键入三个斜杠Visual Studio将帮助你休息。

不要使用花哨的ASCII格式，因为当你重构改变类名称时，你会花费年龄重新格式化所有的盒子，使它们再次很好地排列。

来源

2010-07-12 14:20:47

上述答案中描述的XML文档注释是类文件和方法文档的路径。

如果您需要每个文件中的非文档文本的附加信息，例如创建日期，信用点，版权信息等，可以将其添加为片段或将其添加到适当的Visual Studio模板中。 VS对模板有特殊的变量，如$ username $和$ time $可以用来在每次添加基于模板的新项目时自动插入这些值。

来源

2010-07-12 16:20:53 Rightway

将类描述添加到代码？

回答

相关问题