标签: remarks

在输入代码时,我非常喜欢Visual Studio 2010(Professional)的intellisense功能,特别是我能够查找正在使用的类型的XML注释.(请参阅Microsoft的文档).这项工作到目前为止.但是,XML代码注释的备注部分没有显示出来.

我认为这是一个非常有用的功能,因为通常有用的信息无法从摘要中轻易猜到.(这就是为什么我们有一个备注部分,我猜)

如何在intellisense级别探索Visual Studio 2010(Professional)中的备注部分？(我使用DevXpress Coderush,如果这很重要,但我不这么认为).

我在c#中编写了一个powershell模块,它由一堆PowerShell cmdlet组成.

例如:

得到应用

当我宣布上课时

[Cmdlet(VerbsCommon.Get, "Application")]
    public class GetApplication : PSCmdlet

我可以执行诸如为此cmdlet提供参数以及有关参数本身的有用消息之类的操作.

我正在尝试在我的类中提供更多文档,以便命令如此

get-help get-application

将在REMARKS部分中提供有关cmdlet本身的说明.

知道如何在visual studio 2013中添加它吗？

我正在尝试在我的备注中包含一个URL,如下例所示.这会导致StyleCop根据规则SA1650(备注中拼写错误的单词)报告警告,这对于我们的目的无法抑制(通过策略).这个警告并不奇怪,因为URL语法不要求正确的英文拼写.

...

/// <remarks>
/// <para>... some remarks ...</para>
/// <para>http://www.foo.wtvr.com</para>
/// <para>... some other remarks ...</para>
/// </remarks>

...

首先,在摘要/备注中包含URL被认为是不好的做法吗？我猜不会因为Visual Studio识别链接并使它们可以点击.如有必要,我会删除它,但我想留下其他人的参考.

如果这不被认为是不好的做法,是否有办法让StyleCop忽略URL文本而不抑制警告(或将整个URL或其中的每一部分添加到已识别的单词列表中)？我尝试了以下(URL的行上有四个正斜杠),但结果是来自规则SA1644的警告(文档标题中不允许空行):

...

/// <remarks>
/// <para>... some remarks ...</para>
//// <para>http://www.foo.wtvr.com</para>
/// <para>... some other remarks ...</para>
/// </remarks>

...

我目前的解决方案是使用注释中的注释标记,如下所示,它不会产生任何警告,但我不知道这是否是最佳做法:

...

/// <remarks>
/// <para>... some remarks ...</para>
/// <para><!--http://www.foo.wtvr.com--></para>
/// <para>... some other remarks ...</para>
/// </remarks>

...

帮助我更好地记录我的代码.

我使用remark从vim中的markdown代码制作html幻灯片.

备注需要使用包含html和markdown代码的html模板.

如何让vim在同一个html文件中使用html和markdown语法高亮显示？