1 /// <summary>

本文介绍了一种通过C#代码动态读写App.config配置文件的方法。包括如何设置和获取配置项的值,适用于需要灵活配置应用程序场景。
 1  /// <summary>
2        /// Dynamic Write App.config
3        /// </summary>
4        /// <param name="AppKey"></param>
5        /// <param name="AppValue"></param>
6        public static void SetValue(string AppKey, string AppValue)
7        {
8            XmlDocument xDoc = new XmlDocument();
9            //获取可执行文件的路径和名称
10            xDoc.Load(System.Windows.Forms.Application.ExecutablePath + ".config");
11
12            XmlNode xNode;
13            XmlElement xElem1;
14            XmlElement xElem2;
15            xNode = xDoc.SelectSingleNode("//appSettings");
16
17            xElem1 = (XmlElement)xNode.SelectSingleNode("//add[@key='" + AppKey + "']");
18            if (xElem1 != null) xElem1.SetAttribute("value", AppValue);
19            else
20            {
21                xElem2 = xDoc.CreateElement("add");
22                xElem2.SetAttribute("key", AppKey);
23                xElem2.SetAttribute("value", AppValue);
24                xNode.AppendChild(xElem2);
25            }
26            xDoc.Save(System.Windows.Forms.Application.ExecutablePath + ".config");
27        }
28
29        /**//// <summary>
30        /// Reader App.config 51aspx.com
31        /// </summary>
32        /// <param name="appKey"></param>
33        /// <returns></returns>
34        public static string GetConfigValue(string appKey)
35        {
36            XmlDocument xDoc = new XmlDocument();
37            try
38            {
39                xDoc.Load(System.Windows.Forms.Application.ExecutablePath + ".config");
40
41                XmlNode xNode;//bbs.51aspx.com
42                XmlElement xElem;
43                xNode = xDoc.SelectSingleNode("//appSettings");
44                xElem = (XmlElement)xNode.SelectSingleNode("//add[@key='" + appKey + "']");
45                if (xElem != null)
46                    return xElem.GetAttribute("value");
47                else
48                    return String.Empty;
49            }
50            catch (Exception)
51            {
52                return "";
53            }
54        }
<think> 我们正在讨论的是如何在代码中使用XML注释标签。用户询问的是<summary>、<param>等标签的快捷使用方法。 根据引用内容,XML注释在.NET中用于生成文档,可以通过工具提取生成帮助文档。用户关心的是在编写代码时如何快捷地添加这些注释。 在Visual Studio中,有几种快捷方式可以快速生成XML注释: 1. 输入三个斜杠(`///`):在方法、类或属性的上一行输入三个斜杠,VS会自动生成对应的XML注释模板。例如,在方法上方输入`///`,会自动生成如下结构: ```csharp /// <summary> /// /// </summary> /// <param name="param1"></param> /// <param name="param2"></param> /// <returns></returns> ``` 然后可以快速填充内容。 2. 使用代码片段:VS内置了一些代码片段,例如输入`summary`然后按Tab键两次,会生成一个`<summary>`标签。 3. 安装扩展工具:如ReSharper等,提供更强大的注释生成功能。 4. 参数自动补全:当在`<param>`标签中开始输入参数名时,VS会提供当前方法参数的智能提示。 具体步骤: - 将光标定位到要添加注释的方法、类或属性上方。 - 输入三个斜杠(`///`),VS会自动生成模板。 - 使用Tab键在模板中的不同部分跳转,快速填写内容。 例如,对于一个方法: ```csharp public int Add(int a, int b) { return a + b; } ``` 在方法上方输入`///`后,会自动生成: ```csharp /// <summary> /// /// </summary> /// <param name="a"></param> /// <param name="b"></param> /// <returns></returns> ``` 然后填充内容: ```csharp /// <summary> /// 计算两个整数的和 /// </summary> /// <param name="a">第一个加数</param> /// <param name="b">第二个加数</param> /// <returns>两个整数的和</returns> ``` 这样就能快速完成注释。 此外,对于已有的方法,如果还没有注释,也可以将光标放在方法名上,按快捷键(通常是Ctrl+Shift+D)或在右键菜单中选择“生成文档注释”来添加模板(不同VS版本可能略有不同)。 注意:这些快捷方式在Visual Studio中默认支持,其他IDE如Rider、VS Code等可能需要安装相应插件或配置。 综上所述,最常用的快捷方式就是输入三个斜杠(`///`)来自动生成模板。 </think> 在代码中使用 XML 注释标签(如 `<summary>`、`param>`)的快捷方法主要通过以下方式实现: ### 一、Visual Studio 原生快捷方式 1. **三斜杠自动生成** 在方法/类上方输入 `///`,VS 会自动生成 XML 注释模板: ```csharp public int Calculate(int a, int b) { return a + b; } ``` ↑ 在方法名上方输入 `///` 后自动生成 ↓ ```csharp /// <summary> /// /// </summary> /// <param name="a"></param> /// <param name="b"></param> /// <returns></returns> ``` 2. **参数智能补全** 编辑 `<param>` 标签时,输入 `name=` 后: - 按 `Ctrl+J` 触发参数列表 - 或输入 `"` 后自动显示可用参数名 ### 二、高效编辑技巧 1. **代码片段快捷键** - 输入 `summary` → 按 `Tab` 两次 → 生成完整摘要标签 - 输入 `param` → 按 `Tab` → 生成带 `name` 属性的参数标签 2. **批量生成文档** 在项目属性中启用: ```xml <PropertyGroup> <GenerateDocumentationFile>true</GenerateDocumentationFile> </PropertyGroup> ``` 编译时自动生成 XML 文档文件(引用[4]) ### 三、增强工具推荐 1. **ReSharper 插件** - 按 `Ctrl+Shift+D` 自动生成所有参数标签 - 新增参数时自动更新 `<param>` 标签 2. **VS Code 扩展** 安装 `C# XML Documentation Comments` 扩展: - 右键点击方法 → 选择 `Generate Documentation` - 自动填充继承的注释 ### 四、规范建议 1. **参数注释原则** ```csharp /// <param name="maxRetries"> /// 最大重试次数(值范围 1-10) /// </param> ``` 需包含参数约束和单位说明(引用[3]) 2. **跨文件链接** 使用 `<see cref="OtherClass.Method()"/>` 创建类/方法超链接: ```csharp /// <see cref="Logger.LogError"/> 处理异常记录 ``` 生成的 CHM 文档中可点击跳转(引用[4]) > **最佳实践**:结合 [DocFX](https://dotnet.github.io/docfx/) 或 [Sandcastle](https://github.com/EWSoftware/SHFB) 工具可将 XML 注释自动转换为 CHM/HTML 文档(引用[2][4]),实现代码与文档的同步更新。 --- ### 相关问题 1. 如何在 ASP.NET Core 项目中配置 XML 文档自动发布? 2. XML 注释中的 `<inheritdoc>` 标签如何实现注释继承? 3. 如何为泛型方法编写规范的 XML 注释? 4. 哪些工具可以检查 XML 注释与代码参数的同步性?
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值