C#注释

Posted 2020-06-17

功能：添加完注释后，这些注释将被编译。从而再次使用类，方法，字段的时候，将鼠标置于类名上，IDE将自动显示对这个类的说明文字。

方法：在类名，方法，或字段名上添加三个斜杠‘///’，IDE将自动完成注释框架，程序员可以在该框架中添加类的描述内容。

参数元素很多很复杂，以下例子用了常用的三个。

///<summary>
///Search for the given entry.
///</summary>
///<param name="OriginalFolder">Original Forder</param>
///<param name="TargetFolder">TargetForder</param>
///<return>Return the queried entry if it is found, else return null.</return>

public Entry Search(string OriginalForder, string TargetForder)
{
　　foreach(Entry e in arrEntries)
　　{
　　　　if(e.OriginalForder.Equals(OriginalForder,
　　　　StringComparison.OrdinalIgnoreCase)&&
　　　　　　e.TargetForder.Equals(TargetFolder,
　　　　　　StringComparison.OrdinalIgnoreCase))
　　　　{
　　　　　　return e;
　　　　}　　　　
　　}
　　//If not found
　　return null;

}