C# 类库中添加注释方法

   C#中新建的类库添加注释时,应注意以下问题:

   1、编译动态类库时命名空间要规范,一般不要和类同名,命名空间一般定义格式:项目名+类文件名;

   2、动态类库中,类、方法的注释都采用下列方式注释:

    类注释的格式:

    /// <summary>
    /// 文件名:Ini处理类/
    /// 文件功能描述:读写Ini文件/
    /// 版权所有:Copyright (C) ZGM/
    /// 创建标识:2011.12.13/     /// 修改描述:/
    /// </summary>

    方法注释的格式:

    /// <summary> 
    /// 读出Ini文件
    /// </summary>
    /// <param name="Section">Ini文件中的段落名称</param>
    /// <param name="Key">Ini文件中的关键字</param>
   /// <param name="IniFilePath">Ini文件的完整路径和名称</param>
   /// <returns>Ini文件中关键字的数值</returns>

   3、生成与动态类库相同名称的xml文件,具体设置是:项目右键—>属性—>生成—>XML文档文件选中再编译

   4、引用动态类库时,把类库和同名的xml文件放到同一个文件夹内即可。

posted @   wzwyc  阅读(2785)  评论(0编辑  收藏  举报
编辑推荐:
· 开发者必知的日志记录最佳实践
· SQL Server 2025 AI相关能力初探
· Linux系列:如何用 C#调用 C方法造成内存泄露
· AI与.NET技术实操系列(二):开始使用ML.NET
· 记一次.NET内存居高不下排查解决与启示
阅读排行:
· 阿里最新开源QwQ-32B,效果媲美deepseek-r1满血版,部署成本又又又降低了!
· 开源Multi-agent AI智能体框架aevatar.ai,欢迎大家贡献代码
· Manus重磅发布:全球首款通用AI代理技术深度解析与实战指南
· 被坑几百块钱后,我竟然真的恢复了删除的微信聊天记录!
· 没有Manus邀请码?试试免邀请码的MGX或者开源的OpenManus吧
点击右上角即可分享
微信分享提示