検索
ホームページ開発ツールVSCode便利な VSCode ヘッダー注釈プラグインを共有します: Fileheader Pro

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

Jul 13, 2022 pm 08:22 PM
vscodeヘッダーアノテーションプラグイン

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

インストールと使用

入手方法

    ##Fileheader Pro - Visual Studio Marketplace
  • 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 に関するコメントによってコードがマージされるときに競合が発生するためです。

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

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

FileheaderPro.currentUserName および FileheaderPro.currentUserEmail

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

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

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

FileheaderPro.autoInsertOnCreateFile

ファイル作成時にファイルヘッダーの自動追加を有効にするかどうか注記。デフォルトではオンになっています

FileheaderPro.autoUpdateOnSave

保存時にファイルヘッダーを更新するかどうか。デフォルトで有効になっています。

Fileheader Pro は、必要な場合にのみ内部的にファイル ヘッダーのコメントを更新します。

Q & A

どのように実装されますか?

ES6 の
タグ付きテンプレート

を使用します。

どれが固定文字列で、どれがユーザーによって使用される変数であるかを知ることができます。次に、メインのこの抽象クラス

fileheader-pro/FileheaderLanguageProvider.tsを参照してください・IronLu233/fileheader-pro (github.com)

without me サポートされている言語

これらの言語は現在サポートされています

Javascript

Typescript

Python

以上が便利な VSCode ヘッダー注釈プラグインを共有します: Fileheader Proの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。

声明
この記事は掘金社区で複製されています。侵害がある場合は、admin@php.cn までご連絡ください。
Visual Studioの可用性:どのエディションが無料ですか?Visual Studioの可用性:どのエディションが無料ですか?Apr 10, 2025 am 09:44 AM

VisualStudioの無料バージョンには、VisualStudioCommunityとVisualStudiocodeが含まれます。 1. VisualStudioCommunityは、個々の開発者、オープンソースプロジェクト、小規模チームに適しています。それは強力で、個々のプロジェクトや学習プログラミングに適しています。 2。VisualStudioCodeは、複数のプログラミング言語と拡張機能をサポートする軽量コードエディターです。スタートアップの速度と低いリソースの使用量が速いため、柔軟性とスケーラビリティが必要な開発者に適しています。

Windows 8用のVisual Studioをインストールする方法は?Windows 8用のVisual Studioをインストールする方法は?Apr 09, 2025 am 12:19 AM

Windows 8にVisualStudioをインストールする手順は次のとおりです。1。公式Microsoft WebサイトからVisualStudioCommunity2019インストールパッケージをダウンロードします。 2.インストーラーを実行し、必要なコンポーネントを選択します。 3.インストールが完了した後に使用できます。 Windows 8互換性のあるコンポーネントを選択し、十分なディスクスペースと管理者の権利があることを確認してください。

私のコンピュータはコードとコードを実行できますか?私のコンピュータはコードとコードを実行できますか?Apr 08, 2025 am 12:16 AM

VSCODEは、基本システムの要件が満たされている限り、ほとんどの最新のコンピューターで実行できます。1。オペレーティングシステム:Windows 7以降、MacOS 10.9以降、Linux。 2。プロセッサ:1.6GHz以下。 3。メモリ:少なくとも2GB RAM(4GB以上推奨); 4。ストレージスペース:少なくとも200MBの利用可能なスペース。設定を最適化し、拡張使用を削減することにより、低構成コンピューターでスムーズなユーザーエクスペリエンスを取得できます。

プログラムをWindows 8と互換性のあるものにするにはどうすればよいですか?プログラムをWindows 8と互換性のあるものにするにはどうすればよいですか?Apr 07, 2025 am 12:09 AM

Windows 8でプログラムをスムーズに実行するには、次の手順が必要です。1。互換性モードを使用して、コードを介してこのモードを検出して有効にします。 2. API呼び出しを調整し、Windowsバージョンに従って適切なAPIを選択します。 3.パフォーマンスの最適化を実行し、互換性モードの使用を避け、API呼び出しを最適化し、一般的なコントロールを使用してください。

VSコードはWindows 8で動作しますか?VSコードはWindows 8で動作しますか?Apr 06, 2025 am 12:13 AM

はい、vscodeisCompatibleWithWindows8.1)theinstallerfromthevscodesurethelatest.netframeworkisInstalled.2)installextensionsionsingTheCommandline、NotingSomeMayloadSlower.3)ManageByClusnnnnyRoightEntions、Light -omayloadSlower.3)

VSコードとVisual Studioの違いは何ですか?VSコードとVisual Studioの違いは何ですか?Apr 05, 2025 am 12:07 AM

VSCODEは、複数の言語と拡張機能に適した軽量コードエディターです。 VisualStudioは、主に.NET開発に使用される強力なIDEです。 1.VSCODEは電子に基づいており、クロスプラットフォームをサポートし、モナコエディターを使用します。 2。VisualStudioは、Microsoftの独立したテクノロジースタックを使用して、デバッグとコンパイラを統合します。 3.VSCODEは単純なタスクに適しており、VisualStudioは大規模なプロジェクトに適しています。

Windows 7で実行できるコードエディターはどれですか?Windows 7で実行できるコードエディターはどれですか?Apr 03, 2025 am 12:01 AM

Windows 7で実行できるコードエディターには、メモ帳、sublimeText、およびAtomが含まれます。 1.NOTEPAD:古いシステムに適した軽量で高速な起動。 2.SublimeText:強力で支払われます。 3. atom:非常にカスタマイズ可能ですが、ゆっくりと開始します。

どのWindowsがVisual Studioをサポートしていますか?どのWindowsがVisual Studioをサポートしていますか?Apr 02, 2025 pm 02:12 PM

VisualStudioがサポートするWindowsバージョンには、Windows 10、Windows 11、Windows 7、およびWindows 8.1が含まれます。 1)最新の機能と最良のサポートには、Windows 10またはWindows 11を使用することをお勧めします。 2)特に大規模なプロジェクトを開発する場合、ハードウェア構成で十分であることを確認します。 3)VisualStudio2022は、Windows 11が最適化され、パフォーマンスとユーザーエクスペリエンスの向上を提供します。

See all articles

ホットAIツール

Undresser.AI Undress

Undresser.AI Undress

リアルなヌード写真を作成する AI 搭載アプリ

AI Clothes Remover

AI Clothes Remover

写真から衣服を削除するオンライン AI ツール。

Undress AI Tool

Undress AI Tool

脱衣画像を無料で

Clothoff.io

Clothoff.io

AI衣類リムーバー

AI Hentai Generator

AI Hentai Generator

AIヘンタイを無料で生成します。

ホットツール

ドリームウィーバー CS6

ドリームウィーバー CS6

ビジュアル Web 開発ツール

DVWA

DVWA

Damn Vulnerable Web App (DVWA) は、非常に脆弱な PHP/MySQL Web アプリケーションです。その主な目的は、セキュリティ専門家が法的環境でスキルとツールをテストするのに役立ち、Web 開発者が Web アプリケーションを保護するプロセスをより深く理解できるようにし、教師/生徒が教室環境で Web アプリケーションを教え/学習できるようにすることです。安全。 DVWA の目標は、シンプルでわかりやすいインターフェイスを通じて、さまざまな難易度で最も一般的な Web 脆弱性のいくつかを実践することです。このソフトウェアは、

SAP NetWeaver Server Adapter for Eclipse

SAP NetWeaver Server Adapter for Eclipse

Eclipse を SAP NetWeaver アプリケーション サーバーと統合します。

ゼンドスタジオ 13.0.1

ゼンドスタジオ 13.0.1

強力な PHP 統合開発環境

ZendStudio 13.5.1 Mac

ZendStudio 13.5.1 Mac

強力な PHP 統合開発環境