Giter Club home page Giter Club logo

illuminatedcomments's Introduction

Illuminated Comments

目录

  1. 生效范围
  2. 安装方法
  3. 使用方法
  4. 提示
  5. Credit

生效范围

Visual Studio

  • 经测试,Vsiual Studio 2022 Community
  • 理论上能支持 Visual Studio 2017-2022

图像格式

理论上 WPF 支持的格式都能生效,如:

  • .png
  • .jpg
  • .gif

编程语言

  • C#
  • VisualBasic
  • C/C++
  • ConsoleOutput
  • CSS
  • ENC
  • FindResults
  • F#
  • HTML
  • JavaScript
  • XAML
  • XML
  • TypeScript
  • Python
  • Java

安装方法

  1. 发布页下载 .vsix 文件
  2. 双击 .vsix 开始安装

使用方法

在注释中插入 -image,url='路径/或/URL',scale='数';

示例

  • 插入带缩放的本地图像;
class Program
{
   /// <summary>
   /// <para>查看图片了解更多:</para>
   /// <para>-image,url='Resources/Test.png',scale='1.2';</para>
   /// </summary>
   static void Test()
   {
   }
}
  • 插入不带缩放的网页图像。
class Program
{
   /// <summary>
   /// <para>查看图片了解更多:</para>
   /// <para>-image,url='https://visualstudio.microsoft.com/wp-content/uploads/2022/11/vs-icon.svg';</para>
   /// </summary>
   static void Test()
   {
   }
}

Parameters

名称 必填 描述 示例
url/src 图像源。
可以是路径或 URL;绝对和相对路径皆可。
url='$(ProjectDir)Test.png'
src='D:/Test.png'
url='https://test/test.png'
scale 图像缩放。
请注意,极度放大可能导致显示问题。
scale='3'
scale ='0.2'

环境变量

$(SolutionDir)$(ProjectDir),这两个 Visual Studio 的环境变量可内插进参数 url/src

提示

  • 将图像注释单独放进一个 <para></para> 标签里,因为同一标签内的其他注释不会显示;
  • 图像 URL 前请加上 https://http://

差异

这与 risadamsIlluminated-comments 之间有什么区别?

  • Illuminated-comments 仅会在源代码页面显示图片注释,而快速信息窗口和自动补全窗口不会。
  • Illuminated-comments 并不如其预期一样工作,它在读取图片后不会解除对文件的占用,导致其他应用无法读取或删除图片。

Credit

此扩展是基于 risadamsIlluminated-comments 开发的。

特别感谢 Lacewing,没有他的帮助,我不可能更新得这么快。

illuminatedcomments's People

Contributors

zqzcsilver avatar

Stargazers

ROH avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.