Giter VIP home page Giter VIP logo

cyber5imon / better-comments Goto Github PK

View Code? Open in Web Editor NEW

This project forked from aaron-bond/better-comments

0.0 2.0 0.0 270 KB

Home Page: https://marketplace.visualstudio.com/items?itemName=aaron-bond.better-comments

License: MIT License

TypeScript 30.40% Perl 3.98% TeX 0.43% Clojure 30.18% CSS 0.56% D 0.34% Dart 1.10% Elixir 0.40% Fortran 0.35% GDScript 0.51% Haskell 0.53% HiveQL 0.47% HTML 0.89% JavaScript 2.22% Common Lisp 11.55% MATLAB 0.28% Pascal 3.43% C# 5.72% Nim 6.33% PHP 0.33%

better-comments's Introduction

Better Comments

The Better Comments extension will help you create more human-friendly comments in your code.
With this extension, you will be able to categorise your annotations into:

  • Alerts
  • Queries
  • TODOs
  • Highlights
  • Commented out code can also be styled to make it clear the code shouldn't be there
  • Any other comment styles you'd like can be specified in the settings

Annotated code

Configuration

This extension can be configured in User Settings or Workspace settings.

"better-comments.multilineComments": true
This setting will control whether multiline comments are styled using the annotation tags. When false, multiline comments will be presented without decoration.

"better-comments.highlightPlainText": false
This setting will control whether comments in a plain text file are styled using the annotation tags. When true, the tags (defaults: ! * ? //) will be detected if they're the first character on a line.

better-comments.tags
The tags are the characters or sequences used to mark a comment for decoration. The default 5 can be modifed to change the colors, and more can be added.

"better-comments.tags": [
  {
    "tag": "!",
    "color": "#FF2D00",
    "strikethrough": false,
    "backgroundColor": "transparent"
  },
  {
    "tag": "?",
    "color": "#3498DB",
    "strikethrough": false,
    "backgroundColor": "transparent"
  },
  {
    "tag": "//",
    "color": "#474747",
    "strikethrough": true,
    "backgroundColor": "transparent"
  },
  {
    "tag": "todo",
    "color": "#FF8C00",
    "strikethrough": false,
    "backgroundColor": "transparent"
  },
  {
    "tag": "*",
    "color": "#98C379",
    "strikethrough": false,
    "backgroundColor": "transparent"
  }
]

Supported Languages

  • Ada
  • AL
  • AsciiDoc
  • C
  • C#
  • C++
  • Clojure
  • COBOL
  • CoffeeScript
  • CSS
  • Dart
  • Dockerfile
  • Elixir
  • Erlang
  • F#
  • Fortran
  • gdscript
  • Go
  • GraphQL
  • Groovy
  • Haskell
  • Haxe
  • HiveQL
  • HTML
  • Java
  • JavaScript
  • JavaScript React
  • JSON with comments
  • Julia
  • Kotlin
  • LaTex (inlc. Bibtex/Biblatex)
  • Less
  • Lisp
  • Lua
  • Makefile
  • Nim
  • MATLAB
  • Objective-C
  • Objective-C++
  • Pascal
  • Perl
  • Perl 6
  • PHP
  • Pig
  • PlantUML
  • PL/SQL
  • PowerShell
  • Puppet
  • Python
  • R
  • Racket
  • Ruby
  • Rust
  • SAS
  • Sass
  • Scala
  • SCSS
  • ShaderLab
  • ShellScript
  • SQL
  • STATA
  • Stylus
  • Swift
  • Tcl
  • Terraform
  • Twig
  • TypeScript
  • TypeScript React
  • Verilog
  • Visual Basic
  • Vue.js
  • YAML

better-comments's People

Contributors

aaron-bond avatar bekorn avatar blakewilson avatar chrisokuda avatar javierreyes945 avatar kylestev avatar cyber5imon avatar thewhoareyouperson avatar tobiasbales avatar zhiayang avatar alglez avatar pwelby avatar therustyknife avatar vednoc avatar

Watchers

James Cloos avatar  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.