便利な VSCode ヘッダー注釈プラグインを共有します: Fileheader Pro-VSCode-php.cn

便利な VSCode ヘッダー注釈プラグインを共有します: Fileheader Pro

青灯夜游

リリース： 2022-07-14 21:08:19

転載

3488 人が閲覧しました

VSCode でヘッダーコメントをすばやく作成するにはどうすればよいですか?次の記事では、便利な VSCode ヘッダー注釈プラグインを紹介します: Fileheader Pro: すぐに使用でき、完全にカスタマイズできる Fileheader プラグインを気に入っていただけますか?全体として、とても使いやすいです。ヘッダーコメントの追加は任せてください！

便利な VSCode ヘッダー注釈プラグインを共有します: Fileheader Pro

[推奨学習: 「vscode 入門チュートリアル」]

このようなコメントを先頭に追加する必要がある場合があります。コード。このコメントには、作成者、コードの著作権ライセンスなどの情報が含まれます。追加するたびに繰り返すと非常に面倒に感じてしまいます。開発者として、時間はもちろん非常に重要です。そして、このシーンのためにこのプラグインが生まれ、何も感じずに静かにそれを行うことができます。コードの先頭に ASCII アートを追加したい場合は、次のようにします。あなたのニーズにも対応できます。

/*
 * @Author: IronLu233
 * @Date: 2021-03-10 12:00:00
 * Copyright © 你的公司名字. All rights reserved.
 */

ログイン後にコピー

/*
#### ########   #######  ##    ## ##       ##     ##  #######   #######   #######  
 ##  ##     ## ##     ## ###   ## ##       ##     ## ##     ## ##     ## ##     ## 
 ##  ##     ## ##     ## ####  ## ##       ##     ##        ##        ##        ## 
 ##  ########  ##     ## ## ## ## ##       ##     ##  #######   #######   #######  
 ##  ##   ##   ##     ## ##  #### ##       ##     ## ##               ##        ## 
 ##  ##    ##  ##     ## ##   ### ##       ##     ## ##        ##     ## ##     ## 
#### ##     ##  #######  ##    ## ########  #######  #########  #######   #######  

 * @author        IronLu233 <lrironsora@gmail.com>
 * @date          2022-06-12 22:33:53
 */

ログイン後にコピー

#このコードはここから来ています:
https://github.com/IronLu233/fileheader-pro/blob/main/src/Extension.ts

インストールと使用

入手方法

VSCodeマーケットを展開し、[インストール]

をクリックすると、ヘッダーコメントがサイレントに追加されます。

ファイルコメント内の情報は、バージョン管理ツールから取得されます。現在、プラグインは Git のみをサポートしていますが、将来的には SVN や Mercurial などの他のバージョン管理ツールもサポートする予定です。そのため、Git を使用したプロジェクトでは必ず使用してください。

インストール後、デフォルトのテンプレートはほとんどの使用シナリオを組み合わせることができます。

新しいファイルを作成すると、ファイルヘッダーが自動的に追加されます。したがって、ほとんどの場合、手動で追加する必要はありません。

便利な VSCode ヘッダー注釈プラグインを共有します: Fileheader Pro 既存のコードに手動で追加する必要がある場合は、ファイルを開いてコマンドパネルに移動します [ Ctrl (Mac では Command) Shift P] を押し、「

Fileheader Pro: Add Fileheader

」と入力して Enter を押すと、独創的なコードの先頭にファイルのコメントが適切に追加されていることがわかります。

便利な VSCode ヘッダー注釈プラグインを共有します: Fileheader Pro #保存時にファイルヘッダーのコメントを更新する必要がある場合、Fileheader Pro が自動的にコメントを更新します。

便利な VSCode ヘッダー注釈プラグインを共有します: Fileheader Pro

カスタムテンプレート

組み込みのテンプレートは、ほとんどのシナリオに対応できます。ただし、カスタムテンプレートの強力な機能と統合機能により、カスタムテンプレートを特別に構成する価値があります。

便利な VSCode ヘッダー注釈プラグインを共有します: Fileheader Pro #テンプレートを git に送信することを忘れずに、一緒に開発する学生にも Fileheader Pro をインストールするよう依頼してください

まずテンプレートを作成する必要があります。 VSCode コマンドパネルで、次のコマンドを実行します。
Fileheader Pro: Generate Custom Fileheader Template

;

現時点では、次のコマンドをプロジェクトのルートディレクトリで実行します。便利な VSCode ヘッダー注釈プラグインを共有します: Fileheader Pro .vscode/fileheader.template.js

。クラス

CustomLanguageProvider を変更してください。特に getTemplate メソッドです。その戻り値によって、ファイルヘッダーコメントの最終的な外観が決まります。さらに、言語によって、どの言語のファイルを使用できるかが決まります。 # テンプレート文字列関数を呼び出すには、返されたすべての文字列に対して必ず tpl

を使用してください。そうしないと、奇妙な問題が発生する可能性があります。

変数の各フィールドを使用して処理し、テンプレートに入れることができます。変数のフィールドには次のものが含まれます

#フィールド意味##birthtimemtimebirthimeauthorNameuserName ## が使用されます。 #authorEmail著者の電子メールアドレス。フォールバックメカニズムはと同じです。 # userNameユーザーの名前。 git の場合、は、userEmail ユーザーの電子メールアドレスを取得するために使用されます。 git config user.email会社名。会社をお持ちでない場合は、商工局に行って登録してください。現在のプロジェクトの名前。 VSCode によって開かれたフォルダーの名前現在のファイルのパス現在のファイルのディレクトリパス現在のファイルのファイル名ファイルヘッダーPro のソースコード自体は、カスタムテンプレートを使用してヘッダーコメントを追加します。これも例です:


ファイルが作成された時刻created 、バージョン管理システムによって追跡されている場合は作成時刻がバージョン管理システムから取得され、それ以外の場合はファイルがディスク上に作成された時刻
file 変更された時刻。取得ロジックは	と同じです。 `は mtime の使用をお勧めしません。ファイルが複数の人によって変更されると、mtime に関するコメントによってコードがマージされるときに競合が発生するためです。`
作成者名はバージョン管理ツールの履歴に表示されます。ファイルが新しい場合は、
authorName
git config user.name
Get	companyName
	projectName
	filePath
	dirPath
	fileName

fileheader-pro/fileheader.template.js at main · IronLu233/fileheader-pro (github.com)

設定項目

FileheaderPro.disableFileds

デフォルトテンプレートの場合、そのテンプレートを通じて各フィールドを無効にできます。無効なフィールドはコメントに表示されません。 VSCode の設定インターフェイスで変更できます。

デフォルト値は

['mtime']

です。

mtime を有効にすることはお勧めできません。ファイルが複数の人によって変更されると、mtime に関するコメントによってコードがマージされるときに競合が発生するためです。
FileheaderPro.companyName

設定で会社名をプラグインに伝える必要があります。指定することはできません。どこからでも入手してください！

FileheaderPro.currentUserName および FileheaderPro.currentUserEmail

これら 2 つのフィールドは、テンプレート内の userName および

userEmail## を直接上書きできます。 #変数は、

authorName および authorEmail (ファイルがバージョン管理ツールによって追跡されていない場合) FileheaderPro.dateFormat # にも間接的に影響します。 ##コメント内の日付の形式。参照してください: https://momentjs.com/docs/#/displaying/format