c# – 字典 – 添加注释以驱动智能感知

内容导读

互联网集市收集整理的这篇技术教程文章主要介绍了c# – 字典 – 添加注释以驱动智能感知，小编现在分享给大家，供广大互联网技能从业者学习和参考。文章包含1485字，纯文字阅读大概需要3分钟。

内容图文

有没有办法添加注释来记录Dictionary或ConcurrentDictionary以了解键/值的含义？

例如：

Dictionary<guid, string> _users;

此示例包含用户字典. guid是UserId,字符串是用户名,但除了“知道”之外,很难说出来.

有没有办法添加文档,以便在添加项目时,intellisense告诉开发人员关于密钥&值？

我知道我可以添加< summary>在它上面发表评论并将它放在对象本身中,但在添加,删除等时正在寻找

解决方法:

最近在GOOS书中我发现了在自己的类中打包常见类型(例如集合)的有趣想法：

Try to use the language of the problem you are working on, rather than the language of .Net constructs. It
reduces conceptual gap between domain and code. Also try to limit
passing around types with generics. This is a form of
duplication. It’s a hint that there is domain concept that should be
extracted to type.

坦率地说,我在打包常见的通用集合方面并不是那么极端,但即使给出一个类型自己的名称,它也更容易阅读和理解：

public class UserNameDictionary : Dictionary<int, string>
{
}

非常简单.现在最好阅读：

Dictionary<int, string> users = new Dictionary<int, string>();
UserNameDictionary users = new UserNameDictionary();

您还可以快速为您的班级添加评论：

/// <summary>
/// Represents a dictionary of user names accessed by ids.
/// </summary>

这不会为Add(int,string)等方法添加注释,但是当其他人使用这个类时,他们会考虑UserNameDictionary的上下文,而不是抽象的Dictionary< int,string>上下文.

如果你想让你的课更方便,你可以隐藏基类方法：

public new void Add(int userId, string userName)
{
    base.Add(userId, userName);
}

对于更复杂的用例,我会使用自定义类将代理工作委托给内部字典.

内容总结

以上是互联网集市为您收集整理的c# – 字典 – 添加注释以驱动智能感知全部内容，希望文章能够帮你解决c# – 字典 – 添加注释以驱动智能感知所遇到的程序开发问题。 如果觉得互联网集市技术教程内容还不错，欢迎将互联网集市网站推荐给程序员好友。

内容备注

版权声明：本文内容由互联网用户自发贡献，该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容， 请发送邮件至 gblab@vip.qq.com 举报，一经查实，本站将立刻删除。

内容手机端