C#自动产生注释<summary>

最新推荐文章于 2024-04-29 14:33:39 发布
原创 最新推荐文章于 2024-04-29 14:33:39 发布 · 3.4k 阅读 · 2 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#c#

本文详细介绍了C#编程中使用'///'符号创建方法注释的基本语法和实践，帮助初学者快速上手。

       /// <summary>
        ///
        /// </summary>
        /// <param name="a"></param>
        /// <param name="b"></param>
        /// <returns></returns>
        public int add(int a, int b)
        {
           
            return a + b;


        }

像初学者一般不知道这样这样的注释。很简单，直接“///”就会自动产生这样的注释了。

【C#】Summary注释
Jadon_z的个人博客
10-27 2479
/// Summary注释
请问C#中如何自动生成summary注释
weixin_30670151的博客
11-14 1200
///（summary的框架就出来了） 参考：http://bbs.youkuaiyun.com/topics/310178351 转载于:https://www.cnblogs.com/hellolong/archive/2012/11/14/2770349.html
(C#)dotnet Core 在程序中获取 注释（summary）
qq_51172697的博客
04-29 871
比如我有一个 home 的控制器，我需要将此控制器的提供的接口获取到，成为一个List,然后还要获取到接口的注释一并返回。右键项目，点击属性，新建一个xml 文件用于存放 注释信息（与swagger 获取注释信息一样的）但是summary在编译时是不会被编译的，所以获取到这个比较困难。有个比较怪的需求，就是把我现在所有能够访问的接口都展示出来。summary: 首页接口。返回的数据就是这样的，注释变了之后，此接口的数据也会及时变。生成项目后就能看到，所有注释都被放在了这个文件中。
C#中的<summary>
热门推荐
一只写bug的程序猿的博客
07-20 2万+
初学C#，看公司代码的过程中一步一步学习，现将学习过程中发现的一些知识总结整理出来，无论难易，以供后续不时之需。 在C#中， 标记应当用于描述类型或类型成员。 使用  添加针对某个类型说明的补充信息。 使用 cref 特性可启用文档工具（如Sandcastle）来创建指向代码元素的文档页内部超链接。 标记的文本是唯一有关 IntelliSense 中的类型的信息源，它也显示在
VS 写C# 如何让<summary></summary>单行显示
03-19
<think>好的，我现在需要帮助用户解决在Visual Studio中编写C#时，如何让<summary>注释以单行形式显示的问题。首先，我得理解用户的具体需求。用户可能在使用XML文档注释时，发现默认情况下<summary>的内容会分成...
public interface ICamera : IDisposable { /// <summary> /// 相机是否已连接并就绪 /// </summary> bool IsConnected { get; } /// <summary> /// 相机唯一标识（如 serial number） /// </summary> string CameraId { get; } /// <summary> /// 当前分辨率宽度 /// </summary> int Width { get; } /// <summary> /// 当前分辨率高度 /// </summary> int Height { get; } /// <summary> /// 曝光时间（微秒） /// </summary> double ExposureTimeUs { get; set; } /// <summary> /// 增益（dB 或 raw value，依设备而定） /// </summary> double Gain { get; set; } /// <summary> /// 连接相机 /// </summary> /// <returns>是否成功</returns> bool Connect(); /// <summary> /// 断开连接 /// </summary> void Disconnect(); /// <summary> /// 开始连续采集图像（自由运行模式） /// 图像通过 ImageReceived 事件返回 /// </summary> /// <returns>是否启动成功</returns> bool StartGrabbing(); /// <summary> /// 停止采集 /// </summary> void StopGrabbing(); /// <summary> /// 软触发一次拍照（单帧） /// </summary> /// <returns>是否触发成功</returns> bool Trigger(); /// <summary> /// 获取最近一帧图像（阻塞等待结果） /// </returns> /// <param name="timeout">超时时间（毫秒）</param> /// <returns>位图图像，失败返回 null</returns> Bitmap GrabImage(int timeout = 5000); /// <summary> /// 设置触发模式 /// </summary> /// <param name="mode">触发类型</param> /// <param name="source">触发源（可选，如 Line1, Software）</param> /// <returns>是否设置成功</returns> bool SetTriggerMode(TriggerMode mode, string source = null); /// <summary> /// 图像采集完成后的回调事件 /// 参数: (capturedImage, timestamp, frameId) /// </summary> event Action<Bitmap, DateTime, long> ImageReceived; } /// <summary> /// 触发模式枚举 /// </summary> public enum TriggerMode { /// <summary> /// 自由运行：持续采集 /// </summary> FreeRun, /// <summary> /// 外部硬触发：由 IO 信号触发 /// </summary> HardwareTrigger, /// <summary> /// 软件触发：由程序调用 Trigger() 方法触发 /// </summary> SoftwareTrigger, /// <summary> /// 编码器同步触发（用于线扫飞拍） /// </summary> EncoderTrigger }这是相机接口，你看行吗
最新发布
10-31
/// </summary> int Width { get; set; } /// <summary> /// 当前图像高度（单位：像素） /// 支持通过 setter 修改 AOI /// </summary> int Height { get; set; } /// <summary> /// 曝光时间（微秒） ...
c#里<summary>标签内的<param>标签有什么用
03-28
### C# 中 `<summary>` 标签内的 `<param>` 作用及用法 在 C# 的 XML 文档注释中，`<param>` 是用于描述方法参数的一个重要标签。它位于 `<summary>` 标签下或者与其并列存在，主要用于提供关于方法参数的具体说明...
/// <summary> /// BOM编号 /// </summary> [StringLength(50)] [Required] [Comment("BOM编号")] public string BOMPoNo { get; set; } /// <summary> /// 产品外键 /// </summary> [StringLength(50)] [Required] [Comment("产品外键")] public long? ProductId { get; set; } /// <summary> /// 工艺路线外键 /// </summary> [StringLength(50)] [Required] [Comment("工艺路线外键")] public long? ProcessRoutingId { get; set; } /// <summary> /// BOM版本 /// </summary> [StringLength(300)] [Comment("BOM版本")] public string BOMPoVersion { get; set; } /// <summary> /// 默认BOM /// 1是 /// 2否 /// </summary> public int IsBoM { get; set; } /// <summary> /// 产品编号 /// </summary> [Required] [Comment("产品外键")] public long Product_id { get; set; } /// <summary> /// 产品编号 /// </summary> [StringLength(50)] [Required] [Comment("产品编号")] public string Product_Num { get; set; } /// <summary> /// 产品名称 /// </summary> [StringLength(50)] [Required] [Comment("产品名称")] public string Product_Name { get; set; } /// <summary> /// 产品规格 ///
04-29
<think>好的，我需要帮用户解决关于C#实体类定义的几个问题。用户提到了BOM编号、产品外键、工艺路线外键、BOM版本、默认BOM、产品编号、产品名称和产品规格这些字段。首先，我得确定每个字段的数据类型和约束条件。...
MovePointModes movePoint=new MovePointModes(); if (Axis!=null) { foreach (var model in Axis) { if (model.IsEn) { movePoint.AxisName.Add(model.AxisName); movePoint.Pos.Add(model.RunPos); movePoint.Vel.Add(model.RunVel); movePoint.MoveAxisID.Add(model.AxisID); } } } movePoint.PointName = PointName; movePoint.Note = Note; MovePoints.Add(movePoint); 这是 MovePointModes代码 public class MovePointModes: NotifyPropertyBase { /// <summary> /// 点位名称 /// </summary> private string _PointName; public string PointName { get { return _PointName; } set { _PointName = value; RaisePropertyChanged(); } } /// <summary> /// 速度 /// </summary> private List<double> _Vel; public List<double> Vel { get { return _Vel; } set { _Vel = value; RaisePropertyChanged(); } } /// <summary> /// 目标位置 /// </summary> private List<double> _Pos; public List<double> Pos { get { return _Pos; } set { _Pos = value; RaisePropertyChanged(); } } /// <summary> /// 轴名称 /// </summary> private List<string> _AxisName; public List<string> AxisName { get { return _AxisName; } set { _AxisName = value; RaisePropertyChanged(); } } private List<short> _MoveAxisID; public List<short> MoveAxisID { get { return _MoveAxisID; } set {_MoveAxisID = value; RaisePropertyChanged(); } } /// <summary> /// 注释 /// </summary> private string _Note; public string Note { get { return _Note; } set { _Note = value; RaisePropertyChanged(); } } } public class MovePointModes: NotifyPropertyBase { /// <summary> /// 点位名称 /// </summary> private string _PointName; public string PointName { get { return _PointName; } set { _PointName = value; RaisePropertyChanged(); } } /// <summary> /// 速度 /// </summary> private List<double> _Vel; public List<double> Vel { get { return _Vel; } set { _Vel = value; RaisePropertyChanged(); } } /// <summary> /// 目标位置 /// </summary> private List<double> _Pos; public List<double> Pos { get { return _Pos; } set { _Pos = value; RaisePropertyChanged(); } } /// <summary> /// 轴名称 /// </summary> private List<string> _AxisName; public List<string> AxisName { get { return _AxisName; } set { _AxisName = value; RaisePropertyChanged(); } } private List<short> _MoveAxisID; public List<short> MoveAxisID { get { return _MoveAxisID; } set {_MoveAxisID = value; RaisePropertyChanged(); } } /// <summary> /// 注释 /// </summary> private string _Note; public string Note { get { return _Note; } set { _Note = value; RaisePropertyChanged(); } } } 这样的写法对吗
06-29
在C#中，一个类的定义是否正确通常取决于它是否符合面向对象设计的基本原则，例如封装性、继承性和多态性。对于`MovePointModes`类来说，如果其目的是表示一组与“移动点”相关的模式或状态，并提供对这些模式的操作...
Untiy | C#中的注释 /// ＜summary＞
持续学习！
05-24 1213
在网上查了查资料之后发现/// 这种注释方式更加适合多人协作开发，类似于“使用说明”。总的来说/// 的注释方式为使用注释（帮助使用），//的注释方式为开发注释（辅助开发）函数的语句提示可以让使用者更加清楚的函数的定义与使用方式。
C# 基础（十八）C# 注释 规范：summary
xpj8888的博客
01-10 2130
1、类、属性、方法的注释，统一用下面的方式 /// &lt;summary&gt; /// ********* /// &lt;/summary&gt; 2、字段的注释 2.1、以下两者都可以：  private string m_sStatisticInfo; //统计信息 //统计信息 private string m_sStatisticInfo; ...
终于知道了C#中的summary的注释是怎么用的了
Fighting
04-11 6014
【代码规范实战经验一】：C++/CLR代码注释规范
qq_39116201的博客
08-10 1123
1、C++/CLI的代码注释规范需要与C#中的xml注释规范保持一致； 2、C#查看C++/CLI的代码注释，需要保证C++/CLI的工程输出了代码注释的XML文件，且在C#的工程的运行路径中添加了该XML文件。 C#中的XML注释规范： 所有的XML注释都在三个向前的斜线之后(///)。两条斜线表示是一个注释，编译器将忽略后面的内容。三条斜线告诉编译器，后面是XML注释，需要适当地...
VSCode C# 如何自动生成 <summary>
什么风把您给吹来了
01-09 5672
查看链接 https://blog.youkuaiyun.com/qq_36848370/article/details/89488257
C#中的三种注释与其快捷键、以及创建类时自动生成类的注释的设置方法
Ariel_欢
06-07 1万+
/// <summary> /// 这个方法的作用是求两个整数之间的最大值 /// </summary> /// <param name="n1">第一个整数</param> /// <param name="n2">第二个整数</param> /// <returns>返回较大的整数</returns> public static int GetMax(int n1,int n2) { return n1>n2?n1:n2; } ———————————————
C#——Summary
qq_37233070的博客
01-30 370
C# summary
C# 中注释/// ＜summary＞是什么意思
alexhu2010q的博客
04-09 2万+
平时自己写代码的时候，注释都是用两个斜杠这么写的// 但是我在实际工作时，看到别人写的函数接口前面都是这么写注释的： /// <summary> /// 这是一个函数的例子 /// </summary> void Funtion() { ... } 经过查找资料，我发现原来写注释的方法并不好，如果我用这种方式写注释，会更方便的在使用函数的时候看到对应的注释。 举个例子，...
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值