在C#智能注释时,常常希望它能在开发时显示为换行,使得提示更加友好!原来一直想怎么实现,今天偶然发现原来如此简单,只需将<para> 标记用于诸如 <summary>、<remarks> 或 <returns> 等标记内即可。环境:VS.NET2008
一、注释在开发时换行显示的办法
<para> 标记用于诸如 <summary>、<remarks> 或 <returns> 等标记内,使您得以将结构添加到文本中。
/// <summary>
/// 基类(第1行)
///<para>说明:(第2行)</para>
///<para> 封装一些常用的成员(第3行)</para>
///<para> 前面要用全角空格才能显示出空格来(第4行)</para>
/// </summary>
public class MyBase
{
/// <summary>
/// 构造函数(第1行)
///<para>说明:(第2行)</para>
///<para> 初始化一些数据(第3行)</para>
/// </summary>
public MyBase()
{
//
//TODO: 在此处添加构造函数逻辑
//
}
}
抄自:http://blog.csdn.net/wonsoft/archive/2009/01/02/3685268.aspx
分享到:
相关推荐
注释的格式和规范通常依据语言和团队标准而定,例如在C#中,我们经常使用XML注释为类、方法、属性等添加文档,而在JavaScript中,JSDoc是一种常见的注释方式。 针对C#,Visual Studio的自动注释插件可以极大地简化...
例如,当你在函数、类或者方法前输入"/"或"///"时,Visual Studio会自动生成相应的XML注释模板。对于C#,"///"会生成一个三斜线注释,用于创建XML文档,这在生成API文档时非常有用。输入后,只需填写必要的描述,如...
在软件开发过程中,特别是在使用Visual Studio (VS) 进行.NET框架下的项目开发时,XML文档注释是一种非常有用的工具。它不仅帮助开发者更好地理解代码的功能和用法,还能够为其他项目中的智能提示提供支持。但是,在...
然而,在某些情况下,我们可能需要去除这些注释,比如在发布软件时为了减小文件体积,或者在进行代码分析和优化时避免注释干扰。本篇将详细介绍如何在C#中去除代码注释,以及提供的资源概况。 首先,C#是一种面向...
1. XML注释:C#提供了XML注释,它允许开发者在代码中添加特殊的三斜杠(///)注释,这些注释会在编译时被转换为XML文档,为自动生成文档提供基础。例如: ```csharp /// /// 这是一个示例类 /// public class ...
在C#编程中,注释是用来解释代码功能的文字,分为单行注释(`//`)和多行注释(`/* ... */`)。为了保持代码的可读性和维护性,开发规范通常会要求对关键函数、类和复杂的逻辑结构进行注释。 "C#注释检查工具"就是...
在实际开发中,如果要使用这些翻译后的XML文件,只需要将它们复制到对应的DLL文件所在的目录,Visual Studio等IDE会自动读取并显示中文注释。这样,无论是在新建项目、引用库还是在编写代码的过程中,都可以得到清晰...
1. **XML文档注释**:这是C#中用于生成文档的一种机制,通过在代码中使用三联斜杠(///)注释,VS可以在编译时生成一个XML文件,记录下这些注释。 2. **Visual Studio 项目属性**:在VS中,项目属性可以设置各种...
【C# 编写的Xml编辑器】是一款基于Visual Studio 2010开发的软件项目,主要用于XML文档的创建、查看和编辑。由于项目原始工程可能适用于VS2008,如果你使用的开发环境是VS2008,则需要自行调整工程设置以使其兼容。...
在IT行业中,C#是一种广泛使用的编程语言,尤其在开发Windows桌面应用、Web应用以及游戏等领域。Visual Studio(简称VS)是微软提供的一个强大的集成开发环境(IDE),它支持C#编程并提供了丰富的功能,包括代码编辑...
总的来说,C#中的XML文档注释是提高代码可读性和维护性的重要手段,尤其是在开发大型项目或库时。通过编译DLL并正确引用XML文档,其他开发者可以在使用你的代码时获得详细的帮助信息,提升开发效率。
这些注释可以按照约定俗成的格式编写,例如使用三重斜线(///)来创建XML注释,这将在生成文档或代码提示时提供帮助。模板可能包含以下元素: 1. 类名注释:描述类的主要功能和用途。 2. 属性注释:说明属性的作用...
《Visual Studio 2005 C# 备忘录》 在编程领域,Visual Studio 2005 和 C# 是一套强大的开发工具...通过掌握这些关键知识点,你将在开发过程中事半功倍。在实际工作中,遇到任何问题,欢迎随时交流讨论,共同进步。
在C#编程领域,Visual C# 2005是.NET Framework的一个重要组成部分,它提供了一种强大的、面向对象的编程环境。Express Edition是微软为了满足个人开发者和小型团队需求推出的一个轻量级版本,它具有直观的用户界面...
在本场景中,我们将探讨如何使用C#创建一个XML处理相关的DLL,以及如何在Web应用中引用这个DLL。 首先,创建DLL项目: 1. 打开Visual Studio,选择"新建项目"。 2. 在项目模板中,选择"C# -> 类库",然后命名为...
C#中XML格式的文档注释好处多多:Visual Studio会在很多地方显示这些注释内容(例如,编辑器的工具提示或对象浏览器),还有一些工具(比如NDoc或微软的文档工具Sandcastle) 也可以利用这些注释生成具有良好外观的...
C# XML入门经典——C#编程人员必备的XML技能 作者:[美]Stewart Fraser, Steven 著,毛尧飞,崔伟 译 出版社:清华大学出版社 出版时间:2003年11月 第1章 在C#中使用XML的原因 <br>1.1 使用XML的原因...
C# API中文说明文档是针对使用C#编程语言进行开发的开发者的重要参考资料,特别是与Visual Studio 2012集成开发环境相结合时。C#是一种面向对象的、现代的编程语言,由微软公司开发,广泛应用于构建Windows桌面应用...
XML 文档注释(C# 编程指南) 平台部分 应用程序域(C# 编程指南) 程序集和全局程序集缓存(C# 编程指南) 属性(C# 编程指南) 集合类(C# 编程指南) 异常和异常处理(C# 编程指南) 互操作性(C# ...
XML注释是C#中用于生成文档的重要手段,此插件可以便捷地生成这些注释。功能包括: 1. **类注释**:在类定义上方自动生成描述类用途的XML注释。 2. **方法注释**:为每个方法、构造函数、属性等添加或更新XML注释,...