当前位置:网站首页>Vs code plug-in korofileheader
Vs code plug-in korofileheader
2022-07-03 17:04:00 【fat ۣۖ tiger ۣۖ】
// Head note
"fileheader.customMade": {
// Author Field is the creator of the file Can be in specialOptions Change special properties in
// Company projects and personal projects can be configured with different user names and mailboxes Search for : gitconfig includeIf such as : https://ayase.moe/2021/03/09/customized-git-config/
// Automatically extract the current git config Medium : user name 、 mailbox
"Author": "git config user.name && git config user.email", // Get the user name and mailbox at the same time
// "Author": "git config user.name", // Get user name only
// "Author": "git config user.email", // Get mailbox only
// "Author": "OBKoro1", // Write dead fixed value Not from git config In order to get
"Date": "Do not edit", // File creation time ( unchanged )
// LastEditors、LastEditTime、FilePath Will be updated automatically If you feel that the time is updated too often, you can use throttleTime( The default is 1 minute ) Configuration change update time .
"LastEditors": "git config user.name && git config user.email", // Last editor of the document And Author The fields are consistent
// Because editing the file will change the last editing time , Merging in multi person collaboration will lead to merge
// You can change the time granularity to week 、 Or the month , In this way, conflicts will be reduced a lot . Search change time format : dateFormat
"LastEditTime": "Do not edit", // Last edit time of the file
// Output relative path , similar : / Folder name /src/index.js
"FilePath": "Do not edit", // The relative path of the file in the project Auto update
// The plug-in will automatically move the cursor to Description In the options Easy input Description Fields can be in specialOptions change
"Description": "", // Introduce the function of the file 、 Input parameters of the file 、 The ginseng .
// custom_string_obkoro1~custom_string_obkoro100 Can output custom information
// You can set multiple pieces of custom information Set up a personal signature 、 leave QQ、 Wechat contact information 、 Enter a blank line, etc
"custom_string_obkoro1": "",
// Copyright notice All rights reserved in this document Automatically replace year obtain git Configured user name and mailbox
// Copyright notice obtained git To configure , And Author The fields are consistent : ${git_name} ${git_email} ${git_name_email}
"custom_string_obkoro1_copyright": "Copyright (c) ${now_year} by ${git_name_email}, All Rights Reserved. "
// "custom_string_obkoro1_copyright": "Copyright (c) ${now_year} by Write the dead company name / user name , All Rights Reserved. "
},
// Function Comments
"fileheader.cursorMode": {
"description": "", // After the function annotation is generated , Move the cursor here
"param": "", // param Enable automatic extraction of function parameters You need to place the cursor on the function line or the blank line above the function
"return": "",
},
// Plug in configuration items
"fileheader.configObj": {
"autoAdd": true, // The detection file has no header comments , Automatically add file header comments
"autoAddLine": 100, // How many lines does the file exceed No more automatic header comments
"autoAlready": true, // Only add the languages supported by the plug-in and the user through `language` Option custom comments
"supportAutoLanguage": [], // After setting , Only files in the array can be added automatically
// Automatically add header comment blacklist
"prohibitAutoAdd": [
"json"
],
"prohibitItemAutoAdd": [ " The full name of the project. It is forbidden to automatically add header comments to the project , Use the shortcut keys to add your own " ],
"folderBlacklist": [ "node_modules" ], // Automatic header comments are not allowed for folder or file names
"wideSame": false, // Header annotation equal width setting
"wideNum": 13, // Header comment field length The default is 13
"functionWideNum": 0, // Function annotation equal width setting Set to 0 It is closed
// Insert... In the first few lines of the header comment
"headInsertLine": {
"php": 2 // php file Insert into the second line
},
"beforeAnnotation": {
}, // Insert before the header comment
"afterAnnotation": {
}, // Insert content after header comment
"specialOptions": {
}, // Special field customization such as : Author、LastEditTime、LastEditors、FilePath、Description、Date etc.
"switch": {
"newlineAddAnnotation": true // By default, line breaks are encountered (\r\n \n \r) Add annotation symbols
},
"moveCursor": true, // Automatically move the cursor to Description Place of action
"dateFormat": "YYYY-MM-DD HH:mm:ss",
"atSymbol": ["@", "@"], // Change... In custom comments for all files @ Symbol
"atSymbolObj": {
}, // Change individual language / Of documents @
"colon": [": ", ": "], // Change the comment colon of all files
"colonObj": {
}, // Change individual language / The colon of the file
"filePathColon": " Path separator replacement ", // The default value is : mac: / window yes : \
"showErrorMessage": false, // Whether to display plug-in error notification be used for debugger
"writeLog": false, // Error log generation
"CheckFileChange": false, // When a single file is saved diff Check
"createHeader": false, // Automatically add header comments to new files
"useWorker": false, // Whether to use workspace settings
"designAddHead": false, // Add a header note when adding an annotation pattern
"headDesignName": "random", // Which pattern does the pattern annotation use
"headDesign": false, // Whether to replace head notes with pattern notes
// Whether the custom configuration generates comments within the function Different file types and language types
"cursorModeInternalAll": {
}, // The default is false Generate function comments outside the function
"openFunctionParamsCheck": true, // Turn on and off automatic extraction and addition of function parameters
"functionParamsShape": ["{", "}"], // Function parameter shape customization
// "functionParamsShape": "no type" Function arguments do not require type
"functionBlankSpaceAll": {
}, // Function comment space indented The default is empty object The default value is 0 Don't indent
"functionTypeSymbol": "*", // The default value when the parameter has no type
"typeParamOrder": "type param", // Parameter type and The position of the parameter is customized
"NoMatchParams": "no show param", // No function parameters match , Whether or not shown @param And @return These two lines Default not to show param
"functionParamAddStr": "", // stay type param Add string after It could be a colon , It is convenient to input parameter description
// Custom language comments , Custom cancel head、end part
// Do not set custom configuration language Invalid By default head、end
"customHasHeadEnd": {
}, // "cancel head and function" | "cancel head" | "cancel function"
"throttleTime": 60000, // For the same file I need to 1 Minutes to modify the file again and save it before updating the comments
// Custom language annotation symbols , Override the annotation format of the plug-in
"language": {
// js Suffix file
"js": {
"head": "/$$",
"middle": " $ @",
"end": " $/",
// Function custom annotation symbol : If you have this configuration Will be used by default
"functionSymbol": {
"head": "/******* ", // Unified increase of several * Number
"middle": " * @",
"end": " */"
},
"functionParams": "typescript" // Function annotations use ts Analytical language
},
// Match multiple file suffixes at one time Don't repeat the settings
"h/hpp/cpp": {
"head": "/*** ", // Unified increase of several * Number
"middle": " * @",
"end": " */"
},
// For documents with special requirements, such as :test.blade.php
"blade.php":{
"head": "<!--",
"middle": " * @",
"end": "-->",
}
},
// Default comment Use when no annotation symbol is matched .
"annotationStr": {
"head": "/*",
"middle": " * @",
"end": " */",
"use": false
},
}
边栏推荐
- 静态程序分析(一)—— 大纲思维导图与内容介绍
- [sword finger offer] 58 - I. flip the word order
- IDEA-配置插件
- Deep understanding of grouping sets statements in SQL
- C language string inversion
- Shentong express expects an annual loss of nearly 1billion
- BYD and great wall hybrid market "get together" again
- [Jianzhi offer] 64 Find 1+2+... +n
- Résolution de l'instance d'assemblage - - affichage à l'écran en mode réel
- 深入理解 SQL 中的 Grouping Sets 语句
猜你喜欢
Kotlin学习快速入门(7)——扩展的妙用
線程池:業務代碼最常用也最容易犯錯的組件
PHP online confusion encryption tutorial sharing + basically no solution
utfwry. Dat PHP, about ThinkPHP's method of IP location using utfwry address Library
Life is still confused? Maybe these subscription numbers have the answers you need!
Recommendation of good books on learning QT programming
What material is 12cr1movr? Chemical property analysis of pressure vessel steel plate 12cr1movr
Daily code 300 lines learning notes day 10
Meituan side: why does thread crash not cause JVM crash
Build your own website (23)
随机推荐
LeetCode 1658. Minimum operand to reduce x to 0
SSH连接远程主机等待时间过长的解决方法
On Lagrange interpolation and its application
关于学习Qt编程的好书精品推荐
Redis:关于列表List类型数据的操作命令
C language string practice
function overloading
大消费企业怎样做数字化转型?
数据分析必备的能力
Great changes! National housing prices fell below the 10000 yuan mark
How to delete a specific line from a text file using the SED command?
New library online | cnopendata complete data of Chinese insurance institution outlets
智慧之道(知行合一)
What is the pledge pool and how to pledge?
[combinatorics] recursive equation (example 1 of recursive equation | list recursive equation)
The way of wisdom (unity of knowledge and action)
简单配置PostFix服务器
[combinatorics] recursive equation (characteristic equation and characteristic root | example of characteristic equation | root formula of monadic quadratic equation)
RF Analyze Demo搭建 Step by Step
线程池:业务代码最常用也最容易犯错的组件