C# 关于<;许可>;标签
我正在阅读关于C# 关于<;许可>;标签,c#,xml-documentation,C#,Xml Documentation,我正在阅读关于标记的C#规范,其语法如下: <permission cref="member">description</permission> 但是,规范中有以下示例: /// <permission cref="System.Security.PermissionSet">Everyone can /// access this method.</permission> public static void Test() { } /
标记的C#规范,其语法如下:
<permission cref="member">description</permission>
但是,规范中有以下示例:
/// <permission cref="System.Security.PermissionSet">Everyone can
/// access this method.</permission>
public static void Test() { }
///每个人都可以
///访问此方法。
公共静态无效测试(){}
如果cref
是必须记录可访问性的成员,System.Security.PermissionSet
对其做了什么
真的,我不明白规范的例子 我认为这是为了记录给定方法\类的代码访问安全需求而设计的。例如:
/// <summary>
/// Do stuff
/// </summary>
/// <permission cref="PermissionSet">Caller should have full trust</permission>
[PermissionSet(SecurityAction.LinkDemand, Name = "FullTrust")]
public void DoStuff() {
}
//
///做事
///
///呼叫方应该完全信任
[权限集(SecurityAction.LinkDemand,Name=“FullTrust”)]
公共空间{
}
在这里,我们需要完全信任权限集,并在方法的文档中明确说明这一点。也要考虑这一点:
/// <summary>
/// Do stuff 2
/// </summary>
/// <permission cref="FileIOPermission">Caller should have unrestricted IO access</permission>
[FileIOPermission(SecurityAction.Demand, Unrestricted = true)]
public void DoStuff2() {
}
//
///做事2
///
///调用方应具有不受限制的IO访问权限
[FileIOPermission(SecurityAction.Demand,Unrestricted=true)]
公开作废文件2(){
}
这里我们需要特定的FileIOPermission
(不是权限集),因此我们在文档中明确说明了这一点
这当然不是为了记录成员的可访问性(公共/私人)-为什么这样做?可访问性是函数\类定义的一部分,无需记录
/// <summary>
/// Do stuff 2
/// </summary>
/// <permission cref="FileIOPermission">Caller should have unrestricted IO access</permission>
[FileIOPermission(SecurityAction.Demand, Unrestricted = true)]
public void DoStuff2() {
}