zhaopengme / vscode-fileheader

vscode-fileheader

vscode-fileheader

feature

Add notes to the file header, and supports automatic update file modification time.

eg:

/*
 * @Author: mikey.zhaopeng
 * @Email:  [email protected]
 * @Date:   2016-07-29 15:57:29
 * @Last Modified by: mikey.zhaopeng
 * @Last Modified time: 2016-08-09 13:29:41
 */

Tip: ctrl+alt+i You can insert comments in the head, ctrl+s After you save the file, and automatically update the time and author.

install

Press F1,typeext install fileheader.

Configuration

In the User Settings inside, set and modify the creator's name & email.

"fileheader.Author": "tom",
"fileheader.Email": "[email protected]",
"fileheader.LastModifiedBy": "jerry"

hot key

ctrl+alt+i You can insert comments in the head.

Change log

1.0.0

1. Support hotkey insert header comments
2. Support Save file, automatically update the time
3. Support the configuration and update the creator's name

task

 [] 1. add template 

vscode-fileheader's Issues

行尾加了空格会使eslint报错

由于团队使用了eslint，fileheader生成注释时会自动在行尾加空格，导致eslint报错，而修改fileheader.tpl配置也不生效

Last modified time was not automatically changed on save

hey I'm new to this extension, the last modified time doesn't seem to change when I save file, what are some ways that I can troubleshoot?
based on my understanding of this extension, it should, right?

vscode 文件头部注释插件推荐

koroFileHeader是为Vscode开发的插件，在 VsCode 中通过快捷键ctrl+alt+i在文件头部添加注释。

插件是参照 vscode-fileheader扩展并增加了用户自定义注释功能。

language:

English | 简体中文

[eslint error] the end of each line has a space

[eslint] Trailing spaces not allowed. (no-trailing-spaces)

'@Last Modified time' not getting auto-updated

Is there a shortcut to update the '@last Modified time'?
When I save the code, it's not getting updated. ( I tried to reopen also, still the creation time and update time are the same).

Multiline string settings are now supported in the settings editor

Ref microsoft/vscode#79571

Hi! Just a note that you can now add the "editPresentation": "multilineText" key-value pair to any string setting that can take multiple lines (such as fileheader.tpl). In the settings editor, the setting will then display a textarea rather than a single-line inputbox. The feature is currently available in the Insiders edition of VS Code, and will be released to Stable in around two weeks.

希望楼主可以添加多语言支持

非常感谢，如果能只能shell script， python，或者sql之类的语言支持就更好了。非常感谢！

保存自动更新header不生效

vscode版本 v1.25.1

author添加email信息

当我在author后添加email时："fileheader.Author": "Nemo [email protected]", 显示效果为：* @author: Nemo <[email protected]> ，请问这个无问题如何解决

希望能增加获取文件名的参数

@zhaopengme
我习惯在文件头写入当前文件名，希望增加这个选项

警告：command 'extension.fileheader' not found

安装了，使用快捷键出现这个警告，是什么情况呢。

能不能支持，鼠标光标在哪里，就把注释放在哪里，默认放到头部很纠结啊，一些语言的注释符号不兼容/**/

能不能支持，鼠标光标在哪里，就把注释放在哪里，默认放到头部很纠结啊，一些语言的注释符号不兼容/**/

还在维护更新吗

这个还在维护更新功能吗？同类型的还有koroFileHeader

Doesn't take into account settings for modified.by

I changed settings both in user and workspace, when I modified file it resets to mikey.zhaopeng

Replace comment characters to support other languages

Can you provide a mechanism to replace the Comment with PowerShell Block style, also note the : needs a space for powershell
<#
@author : mikey.zhaopeng
@Date : 2016-07-29 15:57:29
@last Modified by: mikey.zhaopeng
@last Modified time: 2016-08-09 13:29:41
#>

did not work for mac ?

it does not generate the wanted template comment in file header through the key withctrl + option + i.

Headers are displayed in single line in SCSS file

@Last Modified by 存在多余的空格

使用时发现了这种情况：

---

看了下源码可能是由这里导致

https://github.com/zhaopengme/vscode-fileheader/blob/3f930b1014bfe7a271bef1cb5ee80a7db8651e35/extension.js#L94...L103

add python suport

in my python file when i save the file the format is for javasctipt file for python we need hash

javscript format

/*
 * @Author: Georgios X
 * @Date: 2017-10-27 03:45:48 
 * @Last Modified by:   George X
 * @Last Modified time: 2017-10-27 03:45:48 
 */

python.py file

#################################
# @Author: Georgios X
# @Date: 2017-10-27 03:45:48 
# @Last Modified by:   George X
# @Last Modified time: 2017-10-27 03:45:48 
#################################

how to add email to header file

thank you

[feature request] 多语言支持

比如 python 中可以加上

#!/usr/bin/env python
# -*- coding: utf-8 -*-

自定义时间格式样式

应默认使用 /** 而不是 /*

使用 /** 的好处是在 /** 之后按回车自动生成新的注释行

Last Modified time 文件如何根据指纹来变化

如题：有一个文件，没有任何改动，保存时 Last Modified time 变化了，感觉这个设计很不合理，应该判断文件内容是否变化，然后再更新 Last Modified time

How to add custom headers like company name and copyright statement with year..

i want the thing like this.

{
"fileheader.Author": "King",
"fileheader.LastModifiedBy": "King",
"fileheader.Company": "Copyright (c) {year} My World.",
"fileheader.tpl": "/*\r\n * @Company: {Company} \r\n * @author: {author} \r\n * @Date: {createTime} \r\n * @last Modified by: {lastModifiedBy} \r\n * @last Modified time: {updateTime} \r\n */\r\n"
}

please have a look to this package functionality
https://marketplace.visualstudio.com/items?itemName=doi.fileheadercomment

Replacement comment characters / change to comment block for another coding language [solved]

In the "User" settings and "Workspace" settings under the 'vscode-fileheader' extension settings you need to update:

1. Fileheader: Author --> [desired name]
2. Fileheader: Last Modified By -> [desired name]

** this is how you can update the Comment block to suit another programming language:

First, find an example of the Comment block for the desired programming language. Next, DO NOT DELETE the '@author: {author} , @created: {createTime}' , etc. fields in the "Fileheader: Tpl" settings. INSTEAD -- before each "@" symbol, add in the character used for 'newline' for your language of choice ... ex) Python: input "\n" right before the "@" symbols
You can of course delete the extra asterisks (*) inside the "Fileheader: Tpl" field if they are of no use to you in your Comment block
(FINAL STEP): Be sure that you have added the needed "Comment block symbols" at the beginning and end of the field for "Fileheader: Tpl" ... **ex) Python: input """ at both the beginning (before any other characters) and end of the field (after all characters) ... **ex) Powershell: input <# at the beginning of the field before all other characters, and #> at the end of the field after all other characters.
Add in 'newline' ( \n ) as needed to reformat the file header to your liking. REMEMBER: you must make the changes in both "User" and "Workspace" tabs for the extension (make changes in one tab, copy and paste to the other) ... must then close and re-open VS Code before extension changes will take affect

Originally posted by @motraor3 in #16 (comment)

怎么在vscode上修改默认author

Allow to insert year

Currently it's possible to insert the {createTime} or {updateTime}. It would be nice if this could be customized so that it's possible to insert the year without day and month.

This would be helpful for inserting a copyright string in the template, e.g.

// Copyright (c) {year} {author}

One option would be to add a new variable {year} that contains the current year. Another option is to allow to customize the {createTime}/{updateTime}, e.g. by specifying a format: {createTime:yyyy}

希望可以支持用户自定义模板

Hello

由于团队规范需求，希望能够修改配置模板；但是修改模板后保存自动更新 Last Modified Time 这个feature就失效了，看了下代码是由于注释必须是 /* ... */ 的形式。

所以非常希望能够支持自定义模板；或者提供CommentStart和CommentEnd这两个配置项可能也是一种方法。

非常感谢。