Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ttiki/ultra-comment

Add boilerplate code to display information and structure your code through comments! Chose between defferent templates for the headers! Commenting your code has never been easier.
https://github.com/ttiki/ultra-comment

atom atom-package comments extension snippets snippets-collection visual-studio-code

Last synced: 30 days ago
JSON representation

Add boilerplate code to display information and structure your code through comments! Chose between defferent templates for the headers! Commenting your code has never been easier.

Host: GitHub
URL: https://github.com/ttiki/ultra-comment
Owner: Ttiki
License: gpl-3.0
Created: 2022-02-15T19:28:00.000Z (almost 3 years ago)
Default Branch: master
Last Pushed: 2023-09-06T09:42:51.000Z (over 1 year ago)
Last Synced: 2024-11-15T09:49:44.475Z (3 months ago)
Topics: atom, atom-package, comments, extension, snippets, snippets-collection, visual-studio-code
Homepage:
Size: 57.6 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        [![GitHub](https://img.shields.io/github/license/Ttiki/ultra-comment)](https://github.com/Ttiki/ultra-comment/blob/master/LICENCE.md)

[![Latest version](https://img.shields.io/github/v/tag/Ttiki/ultra-comment)](https://github.com/Ttiki/ultra-comment/releases)

[![Downloads](https://img.shields.io/github/downloads/Ttiki/ultra-comment/total)](https://github.com/Ttiki/ultra-comment/releases)

[![Open Issue](https://img.shields.io/github/issues-raw/Ttiki/ultra-comment)](https://github.com/Ttiki/ultra-comment/issues)

[![Open PR](https://img.shields.io/github/issues-pr-raw/Ttiki/ultra-comment)](https://github.com/Ttiki/ultra-comment/pulls)

[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&link=Ttiki)][SPONSOR]

# Header comments

>Note: This README is also available in:

>- [![French](Res/media/icons/fr.gif) Français][README_FR]

Add boilerplate code when you start a new file to store informations (such as the name of the file/class, author's name, date of creation, etc.)

**PLUS, a bonus snippet to structure your code by adding some additional information!**

This extension is available for the following text editor / IDE :

- [x] Visual Studio Code

- [] Atom (Newer versions aren't supported for the moment.)

##  Studio Code

### Features

Here is a list of features from the Vistual Studio Code Header comment extension:

- Snippets automaticaly adapts to the language you're using

- Dates automaticaly updates

- Multiple templates you can use (depending on your need and styles)

- Multi-languages (english, french, etc.)

- An handy snippet to structure your code (complementary-information, see gif below for a demonstration)

**Header comments**

![Header comments features in Visual Studio Code][FEATURE_VSCODE]

**Complementray information**

![Complementary information to structure your code][FEATURE_VSCODE_BONUS]

### Installation

1. To install this extension [download the latest release for your text editor/IDE][RELEASES].

1. Unzip it inside **/.vscode/extensions**

2. Restart Visual Studio Code

3. You're done! Now, just type one template's name and voilà!

---

## Atom

### Features

Here is a list of features from the Atom Header comment extension:

- Snippet available for the following languages

  - Java

  - C

  - C++

  - C#

  - Ruby

  - Python

  - HTML

  - CSS

  - SCSS

  - SASS

  - Javascript

  - PHP

  - XML

  - Yaml

- Multi-languages (english, french, etc.)

- An handy snippet to structure your code (complementary-information, see gif below for a demonstration)

**Header comments**

![Header comments features in Visual Studio Code][FEATURE_ATOM]

**Complementray information**

![Complementary information to structure your code][FEATURE_ATOM_BONUS]

### Installation

To install this extension:

1. [Download the latest release for your text editor/IDE][RELEASES].

2. Unzip it inside **/.atom/packages**

3. Restart Atom

4. Check if enabled by going to : **File/Settings/Packages and search for header-comments

5. You're done! Now, just type one template's name and voilà!

---

## Credits

- [Flags icon by FamFam](http://www.famfamfam.com)

- [Badges by Shields.io](https://shields.io/)

[README_FR]: Res/READMEs/README_fr.md

[FEATURE_VSCODE]: Res/media/gif/feature_vscode.gif

[FEATURE_VSCODE_BONUS]: Res/media/gif/features_ci_vscode.gif

[FEATURE_ATOM]: Res/media/gif/feature_atom.gif

[FEATURE_ATOM_BONUS]: Res/media/gif/features_ci_atom.gif

[RELEASES]: https://github.com/Ttiki/header-comments/releases

[SPONSOR]: https://github.com/sponsors/Ttiki