评审的代码 (托管包结构)

编程语言通常提供方法说明或注释代码。 注释是提供有关代码的附加信息文本的部分,但在编译或解释时被忽略。

托管包框架 (MPF)类提供对注释和取消注释选定的文本支持。

注释样式

包含注释两个泛型样式:

  1. 行注释,这些注释在一行。

  2. 块注释,注释可以包含多个行。

,当块注释具有开始时间和结束字符时,行注释通常具有开始字符 (或字符)。 例如,在 c# 中,行注释从 //,开始,从而阻止注释以/* 和结束开始使用 *。

当用户选择命令 注释选择编辑 - 时 AMP_GT 高级 菜单,命令传送到 Source 类的 CommentSpan 方法。 当用户选择命令 取消注释选择时,命令路由到 UncommentSpan 方法。

支持代码注释

可以使语言服务通过名为 ProvideLanguageServiceAttribute 参数的 EnableCommenting 支持代码注释。 这将设置 LanguagePreferences 类的 EnableCommenting 属性。 有关设置语言 servicce 功能的更多信息,请参见 注册语言服务 (托管包结构))。

您还必须重写 GetCommentFormat 方法返回包含注释字符的一 CommentInfo 结构该语言的。 c# 样式行注释字符是默认设置。

示例

这是 GetCommentFormat 方法的示例实现。

using Microsoft.VisualStudio.Package;

namespace MyLanguagePackage
{
    class MySource : Source
    {
        public override CommentInfo GetCommentFormat() {
            CommentInfo info = new CommentInfo();
            info.LineStart       = "//";
            info.BlockStart      = "/*";
            info.BlockEnd        = "*/";
            info.UseLineComments = true;
            return info;
        }
    }
}

请参见

概念

注册语言服务 (托管包结构)

其他资源

语言服务功能 (托管包结构)