why06 / comment-headers

Comment headers for VS Code. Add Odin

COMMENT HEADERS

How To Use • Types • Line styles • Supported languages

Write beautifully structured code 🎉

Supports 30+ languages

Works with Better comments

〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰

How to use

Type a trigger keyword like //header-lg and press enter.
Find the different triggers in the types section.

〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰

Types

1. Block

Type	Identifier	Example
Default	block	//block-md..
Info	info-block ,*block	//info-block-md, //*block-md..
Question	question-block,?block	//question-block-md , //?block-md..
Warning	warning-block,!block	//warning-block-md, //!block-md..
Todo	todo-block	//todo-block-md..
Function	function-block	//function-block-md,..
About	about-block	//about-block-md..

2. Header

Type	Identifier	Example
Default	header	//header-md..
Info	info-header , *header	//info-header-md, //*header-md..
Question	question-header, ?header	//question-header-md , //?header-md..
Warning	warning-header, !header	//warning-header-md, //!header-md..
Todo	todo-header	//todo-header-md..

3. Footer

Type	Identifier	Example
Default	end	//end-sm, //end-md ..

4. Divider

Type	Identifier	Example
Default	divider	//divider-sm, //divider-md ..

5. Divider plain

Type	Identifier	Example
Default	divider-plain	//divider-plain-sm, //divider-plain-md ..

6. Inline

Type	Identifier	Example
Default	comment	//comment
Info	info , *	//info, //*
Question	question, ?	//question , //?
Warning	warning, !	//warning, //!
Todo	todo	//todo

7. Multiline

Type	Identifier	Example
Default	multiline	//multiline

〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰

Line Style

Type	Identifier	Example
Single lined	/	/header-sm
Double lined	//	//header-sm

Single lined

Double lined

〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰

Sizes

Type	Identifier	Example
Small	-sm	//header-sm
Medium	-md	//header-md
Large	-lg	//header-lg
Extra Large	-xl	//header-xl
Extra Extra Large	-xxl	//header-xxl

Note: Inline(6) and Multiline (7) comments do not have size option.

〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰

Supported Languages

(expand)

• C
• C#
• C++
• Coffeescript
• Coldfusion*
• CSS
• Dart
• Dockerfile
• Go
• Groovy
• HTML*
• Java
• Javascript
• JOSC
• LESS
• Markdown*
• Nested
• Nim
• Objective-c
• Objective-cpp
• Perl
• Php
• Powershell
• Puppet
• Python
• R
• Ruby
• Rust
• SASS
• SCSS
• Shellscript
• SQL
• Stylus
• Swift
• TCL
• Typescript
• Vue
• XML*
• XSL*
• YAML
  *supports only dividers

〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰〰

Happy Coding