文档章节

缺少公开可见的类型或成员的XML注释

 技术盛宴
发布于 02/20 17:27
字数 701
阅读 96
收藏 0

我收到以下警告:“缺少公开可见的类型或成员的XML注释”。

如何解决呢?


#1楼

我想在这里列出的答案中添加一些内容:

正如Isak所指出的,XML文档对于类库很有用,因为它为Visual Studio中的任何使用者提供了智能感知。 因此,一个简单而正确的解决方案是简单地关闭任何顶级项目(如UI等)的文档,而这些文档不会在自己的项目之外实现。

另外,我想指出的是,警告仅针对公开可见的成员。 因此,如果您将类库设置为仅公开其需要的内容,则无需记录private成员和internal成员就可以实现。


#2楼

将属性附加到方法后,我收到了该消息

[webMethod]
public void DoSomething()
{
}

但是正确的方法是这样的:

[webMethod()] // Note the Parentheses 
public void DoSomething()
{
}

#3楼

插入XML注释。 ;-)

/// <summary>
/// Describe your member here.
/// </summary>
public string Something
{
    get;
    set;
}

乍一看,这可能看起来像个玩笑,但实际上可能有用。 对我而言,思考甚至对私有方法也可以使用的方法很有帮助(当然,除非真的很琐碎)。


#4楼

5个选项:

  • 填写文档注释(很棒,但是很耗时)
  • 关闭注释生成(在项目属性中)
  • 禁用项目属性中的警告(在“项目属性”中,转到“项目属性”->“构建”>“错误和警告”(部分),禁止警告(文本框),添加1591(逗号分隔列表))。 默认情况下,它将更改活动配置,请考虑将配置更改为全部。
  • 使用#pragma warning disable 1591仅对某些代码位禁用警告(然后#pragma warning restore 1591
  • 忽略警告(不好的主意-您会错过新的“真实”警告)

#5楼

向公开可见的类型和成员添加XML注释:)

///<Summary>
/// Gets the answer
///</Summary>
public int MyMethod()
{
   return 42;
}

您需要所有成员都具有这些<summary>类型的注释-这些注释也会显示在intellisense弹出菜单中。

收到此警告的原因是因为您已将项目设置为输出文档xml文件(在项目设置中)。 这对类库(.dll程序集)很有用,这意味着.dll的用户可以在Visual Studio中直接获取API的智能文档。

我建议您给自己一份GhostDoc Visual Studio 插件的副本。使文档编写变得容易得多。

本文转载自:https://stackoom.com/question/r27/缺少公开可见的类型或成员的XML注释

粉丝 0
博文 1583
码字总数 0
作品 0
深圳
高级程序员
私信 提问
加载中

评论(0)

深入理解注解(Annotation)

在现在的开发中,注解越来越多地应用到了开发中,无论是Servlet3.0新特性,还是SSH中的全注解,都给开发带来了极大的便利, 直观. 因此需要对注解有深入的理解. 一. 自定义注解 自定义注解的目...

长平狐
2012/09/03
354
0
.NET Core WebApi帮助文档使用Swagger生成Api说明文档

Swagger也称为Open API,Swagger从API文档中手动完成工作,并提供一系列用于生成,可视化和维护API文档的解决方案。简单的说就是一款让你更好的书写API文档的框架。 我们为什么选择swagger,...

zock
2019/09/20
0
0
Java代码规范、格式化和checkstyle检查配置文档

为便于规范各位开发人员代码、提高代码质量,研发中心需要启动代码评审机制。为了加快代码评审的速度,减少不必要的时间,可以加入一些代码评审的静态检查工具,另外需要为研发中心配置统一的...

凯文加内特
2016/03/16
756
0
Spring注解详解1——【转】

概述 注释配置相对于 XML 配置具有很多的优势: 它可以充分利用 Java 的反射机制获取类结构信息,这些信息可以有效减少配置的工作。如使用 JPA 注释配置 ORM 映射时,我们就不需要指定 PO 的...

关河
2016/01/25
63
0
Asp.Net Core Web Api 使用 Swagger 生成 api 说明文档

  最近使用 Asp.Net Core Web Api 开发项目服务端。Swagger 是最受欢迎的 REST APIs 文档生成工具之一,进入我的视野。以下为学习应用情况的整理。 一、Swagger 介绍   使用 Swagger 作为...

Now,DayBreak
2019/07/29
0
0

没有更多内容

加载失败,请刷新页面

加载更多

数组foreach()遍历中的传递引用

在PHP的foreach ($arr as $k => $v) 的遍历中,每一轮的遍历,都发生了以下事情 $k = currentKey($arrCopy); //将副本数组本轮次的键的值分配给$k,比如下标0,1,2等;$v = currentVal($arrCo...

vinci321
今天
140
0
将文件从Docker容器复制到主机 - Copying files from Docker container to host

问题: I'm thinking of using Docker to build my dependencies on a Continuous Integration (CI) server, so that I don't have to install all the runtimes and libraries on the agent......

技术盛宴
今天
117
0
略谈分布式系统中的容器设计模式

本文作者:zytan_cocoa 略谈分布式系统中的容器设计模式 谭中意 2020/3/5 前言:云原生(Cloud Native)不仅仅是趋势,更是现在进行时,它是构建现代的,可弹性伸缩的,快速迭代的计算网络服...

百度开发者中心
03/11
138
0
elasticsearch 第三讲

es的详细介绍 SearchTemplate tmdb 表示的是模板名称 dmdb1 表示的是当前的索引 脚本方式编辑 ##编辑模板POST _scripts/tmdb{ "script": { "lang": "mustache", "source": { ......

鸡蛋炒馒头
今天
215
0
IDEA新建springMVC项目,启动后访问Controller报404

IDEA新建springMVC项目,启动后可以访问到默认的index.jsp,但是访问controller就报404 查看web.xml配置 spingmvc.xml配置 都没有问题 请求的url也和定义的@RequestMapping一致。也没有问题。...

vicky_dimi
今天
322
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部