koro1FileHeader

VSCode插件：自动生成，自动更新VSCode文件头部注释, 自动生成函数注释并支持提取函数参数，支持所有主流语言，文档齐全，使用简单，配置灵活方便，持续维护多年。

5,565

265

5,565

View on GitHub

Top Related Projects

atom-beautify

1,496

:mega: Help Wanted - Looking for Maintainer: https://github.com/Glavin001/atom-beautify/issues/2572 | :lipstick: Universal beautification package for Atom editor (:warning: Currently migrating to https://github.com/Unibeautify/ and have very limited bandwidth for Atom-Beautify Issues. Thank you for your patience and understanding :heart: )

Quick Overview

Koro1FileHeader is a VSCode extension that automatically adds customizable file headers and function comments to your code files. It supports multiple programming languages and provides various configuration options to tailor the headers and comments to your project's needs.

Pros

Supports a wide range of programming languages
Highly customizable header and function comment templates
Automatic update of last modified time in file headers
Integrates seamlessly with VSCode and respects user-defined keyboard shortcuts

Cons

Limited to VSCode, not available for other IDEs or text editors
May require initial setup and configuration to match specific project requirements
Some users report occasional issues with certain language-specific features

Getting Started

Install the extension from the VSCode marketplace
Open your VSCode settings (JSON) and add the following configuration:

"fileheader.customMade": {
    "Author": "Your Name",
    "Date": "Do not edit",
    "LastEditors": "Your Name",
    "LastEditTime": "Do not edit",
    "Description": ""
},
"fileheader.cursorMode": {
    "description": "",
    "param": "",
    "return": ""
}

Use the keyboard shortcut Ctrl+Alt+i (Windows/Linux) or Ctrl+⌘+i (Mac) to insert a file header
Use the keyboard shortcut Ctrl+Alt+t (Windows/Linux) or Ctrl+⌘+t (Mac) to insert a function comment

For more detailed configuration options, refer to the extension's documentation on GitHub.

Competitor Comparisons

atom-beautify

1,496

Pros of atom-beautify

Supports a wide range of programming languages and file types
Offers extensive customization options for formatting rules
Integrates well with the Atom text editor ecosystem

Cons of atom-beautify

May have performance issues with large files or projects
Requires separate beautifier packages for some languages
Configuration can be complex for beginners

Code comparison

atom-beautify:

beautify.beautify(editor).then(function() {
  console.log('Beautification complete');
}).catch(function(error) {
  console.error('Error beautifying:', error);
});

koro1FileHeader:

vscode.commands.registerCommand('extension.fileheader', function () {
    fileheader.cursorTip();
    fileheader.headerPattern();
});

Summary

atom-beautify is a versatile code formatting tool for Atom, supporting multiple languages and offering extensive customization. However, it may face performance issues with large files and require additional setup for certain languages. koro1FileHeader, on the other hand, focuses on adding file headers and is primarily designed for VS Code. While it has a more specific use case, it's generally simpler to set up and use for its intended purpose.

Convert designs to code with AI

Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.

Try Visual Copilot

README

koroFileHeader

ç®ä»

VSCodeæä»¶: ç¨äºä¸é®çææä»¶å¤´é¨æ³¨éå¹¶èªå¨æ´æ°æåç¼è¾äººåç¼è¾æ¶é´ãå½æ°æ³¨éèªå¨çæååæ°æåã
æä»¶å¯ä»¥å¸®å©ç¨æ·å»æè¯å¥½çç¼ç ä¹ æ¯ï¼è§èæ´ä¸ªå¢éé£æ ¼ã
ä»2018å¹´5æç»´æ¤è³ä», å³éissue 500+ ï¼æ¥æ39.7w+çç¨æ·ï¼VSCodeå¾è¡¨ç»è®¡æ¥åå®è£200-500
ç»è¿å¤çè¿ä»£åï¼æä»¶æ¯æææä¸»æµè¯è¨,çµæ´»æ¹ä¾¿ï¼ææ¡£é½å¨ï¼é£ç¨ç®åï¼
è§å¾æä»¶ä¸éçè¯ï¼å°±ç»ä¸ªStarâï¸å§~