如何在WPF中编写方法文档 及在IntelliJ中指定方法返回类型

问题1：IntelliJ无法正确识别C#方法泛型返回类型的解决方法 #

• 首先调整XML注释写法：你当前在<returns>标签中直接写List<String>的写法会被XML解析器误判为嵌套标签，正确的泛型注释写法要使用<see>标签引用类型，示例如下：

/// <summary>
/// 返回字符串类型的列表
/// </summary>
/// <returns><see cref="List{T}"/>，泛型参数为<see cref="string"/>类型的元素集合</returns>
private List<string> GetListOfStrings(){
   // Code...
   return list;
}

• 其次检查IDE配置：
  • 确认你安装的C#相关插件（如ReSharper、IntelliJ C#插件）已启用且版本适配当前项目的.NET版本
  • 进入设置路径：文件 -> 设置 -> 编辑器 -> 代码完成 -> C#，确认「启用XML注释支持」选项已勾选
  • 若配置无误仍识别异常，执行文件 -> 清除缓存并重启，等待IDE重新索引项目文件即可。IDE本身优先读取方法签名的类型定义，索引正常时不会出现泛型识别错误

问题2：WPF项目代码文档编写规范建议 #

• 核心成员注释要求：
  • 自定义依赖属性必须注释属性作用、绑定支持方向、默认值、适用场景
  • 路由事件必须注释触发条件、事件参数包含的信息、路由策略（冒泡/隧道/直接）
  • 转换器（IValueConverter、IMultiValueConverter）必须注释输入输出类型、转换规则、特殊值处理逻辑
  • ViewModel层的公共属性、方法要注释对应的业务含义、关联的视图交互场景
  • 自定义控件的类注释要说明控件的适用场景、和原生控件的差异、核心功能点
• 注释格式规范：
  • 所有公共访问级别的成员必须添加XML注释，私有成员和内部成员按需补充，复杂业务逻辑无论访问级别都要加注释说明逻辑
  • 可使用<example>标签补充代码示例，尤其是自定义控件、公共工具类的用法示例
  • 涉及枚举类型的参数、返回值要注释不同枚举值对应的业务含义

内容的提问来源于stack exchange，提问作者Sharki