GitDiffMargin 项目教程

1. 项目的目录结构及介绍

GitDiffMargin 项目的目录结构如下：

GitDiffMargin/
├── GitDiffMargin.Extension/
├── GitDiffMargin.Shared/
├── GitDiffMargin.Shim/
├── GitDiffMargin.UnitTests/
├── GitDiffMargin.ChocolateyPackage/
├── .gitattributes
├── README.md

目录介绍

• GitDiffMargin.Extension: 包含 Visual Studio 扩展的主要代码。
• GitDiffMargin.Shared: 包含共享的代码和资源。
• GitDiffMargin.Shim: 包含用于兼容不同版本的 Visual Studio 的代码。
• GitDiffMargin.UnitTests: 包含单元测试代码。
• GitDiffMargin.ChocolateyPackage: 包含用于 Chocolatey 包管理的文件。
• .gitattributes: Git 属性文件，用于配置 Git 的行为。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

项目的启动文件位于 GitDiffMargin.Extension 目录中。主要的启动文件是 GitDiffMarginPackage.cs，它负责初始化和加载 Visual Studio 扩展。

// GitDiffMargin.Extension/GitDiffMarginPackage.cs
using System;
using System.Runtime.InteropServices;
using Microsoft.VisualStudio.Shell;

namespace GitDiffMargin
{
    [PackageRegistration(UseManagedResourcesOnly = true)]
    [InstalledProductRegistration("#110", "#112", "1.0", IconResourceID = 400)]
    [Guid(GitDiffMarginPackage.PackageGuidString)]
    public sealed class GitDiffMarginPackage : Package
    {
        public const string PackageGuidString = "your-guid-here";

        public GitDiffMarginPackage()
        {
            // 初始化代码
        }

        protected override void Initialize()
        {
            base.Initialize();
            // 初始化扩展的代码
        }
    }
}

3. 项目的配置文件介绍

项目的配置文件主要包括 .gitattributes 和 GitDiffMargin.Extension 目录中的 source.extension.vsixmanifest。

.gitattributes

.gitattributes 文件用于配置 Git 的行为，例如文件的换行符处理等。

# .gitattributes
* text=auto

source.extension.vsixmanifest

source.extension.vsixmanifest 文件是 Visual Studio 扩展的清单文件，包含了扩展的元数据和依赖项。

<!-- GitDiffMargin.Extension/source.extension.vsixmanifest -->
<PackageManifest Version="2.0.0" xmlns="http://schemas.microsoft.com/developer/vsx-schema/2011">
  <Metadata>
    <Identity Id="GitDiffMargin" Version="1.0" Language="en-US" Publisher="Laurent Kempé" />
    <DisplayName>Git Diff Margin</DisplayName>
    <Description>Displays live Git changes of the currently edited file on Visual Studio margin and scroll bar.</Description>
    <Tags>git, diff, margin, scrollbar</Tags>
  </Metadata>
  <Installation>
    <InstallationTarget Id="Microsoft.VisualStudio.Community" Version="[11.0,17.0)" />
  </Installation>
  <Dependencies>
    <Dependency Id="Microsoft.Framework.NDP" DisplayName="Microsoft .NET Framework" Version="[4.5,)" />
  </Dependencies>
  <Assets>
    <Asset Type="Microsoft.VisualStudio.MefComponent" Path="GitDiffMargin.Shared\GitDiffMargin.Shared.csproj" />
  </Assets>
</PackageManifest>

以上是 GitDiffMargin 项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用该项目。