Dil

İzlenecek yol: Visual Studio'da kod parçacığı oluşturma

Yinelenen kod yazmak veya örnekleri aramak için harcanan süreyi azaltmak için kod parçacıkları kullanarak üretkenliği ve güvenilirliği artırabilirsiniz. Kod parçacıkları, uygulamanıza eklemeye hazır önceden kimlik doğrulaması yapılan kod parçalarıdır.

Kendi kod parçacıklarınızı oluşturabilir ve Visual Studio'nun zaten içerdiği kod parçacıklarına ekleyebilirsiniz. Bu makalede, yalnızca birkaç adımda kod parçacığı oluşturma adımları anlatılır. Bir XML dosyası oluşturur, uygun öğeleri doldurur ve kodunuzu dosyaya eklersiniz. İsteğe bağlı olarak değiştirme parametrelerini ve proje referanslarını kullanabilirsiniz. Ardından, kod parçacığını Visual Studio yüklemenize aktarırsınız.

Kod parçacığı oluşturma

  1. Visual Studio'yu açın ve Başlangıç ekranında Kod olmadan devam et'i seçin.

    Kod olmadan devam et seçeneğinin seçili olduğu Başlangıç penceresinin ekran görüntüsü.

    Kod olmadan devam et seçeneğinin seçili olduğu Başlangıç penceresinin ekran görüntüsü.

  2. Menü çubuğundanDosya Yeni Dosya'yı> seçin veya Ctrl+N girin.

  3. Yeni Dosya iletişim kutusunda XML Dosyası'nı ve ardından Aç'ı seçin.

    XML Dosyası seçeneğinin seçili olduğu Yeni Dosya iletişim kutusunun ekran görüntüsü.

    XML Dosyası seçeneğinin seçili olduğu Yeni Dosya iletişim kutusunun ekran görüntüsü.

  4. Aşağıdaki temel kod parçacığı şablonunu kod düzenleyicisine yapıştırın.

    <?xml version="1.0" encoding="utf-8"?>
    <CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
        <CodeSnippet Format="1.0.0">
            <Header>
                <Title></Title>
            </Header>
            <Snippet>
                <Code Language="">
                    <![CDATA[]]>
                </Code>
            </Snippet>
        </CodeSnippet>
    </CodeSnippets>
    
  5. Başlığı Square Root kod parçacığı Title öğesine girin.

  6. öğesinin Language özniteliğinde Code C# kod parçacığı için CSharp veya Visual Basic için VB yazın.

    Tip

    Kullanılabilir tüm dil değerlerini görmek için Kod parçacıkları şema başvurusundakiÖznitelikler bölümüne bakın.

  7. Code öğesinin içindeki CDATA bölümüne aşağıdaki kod parçacığını ekleyin.

    C# için:

        <![CDATA[double root = Math.Sqrt(16);]]>
    

    Visual Basic için:

        <![CDATA[Dim root = Math.Sqrt(16)]]>
    

    Uyarı

    Kod parçacığının bölümünde kod CDATA satırlarının nasıl biçimlendirileceğini veya girintileneceğini belirtemezsiniz. Eklendikten sonra, dil hizmeti eklenen kodu otomatik olarak biçimlendirer.

  8. Kod parçacığını herhangi bir yere SquareRoot.snippet olarak kaydedin.

Kod parçacığını içeri aktarma

  1. Kod parçacığını Visual Studio yüklemenize aktarmak için Araçlar>Kod Parçacıkları Yöneticisi'ni seçin veya Ctrl+K, B tuşlarına basın.

  2. Kod Parçacıkları Yöneticisi'ndeİçeri Aktar düğmesini seçin.

  3. Kod parçacığınızın konumuna gidin, kod parçacığını seçin ve Aç'ı seçin.

  4. Kod Parçacığını İçeri Aktar iletişim kutusunda, sağ bölmedeki Kod Parçacıklarım klasörünü seçin. Bitir'i ve sonra Tamam'ı seçin.

    Kod parçacığı, kod diline bağlı olarak aşağıdaki konumlardan birine kopyalanır:

    • %USERPROFILE%\Documents\Visual Studio 18\Code Snippets\Visual C#\Kod Parçacıklarım
    • %USERPROFILE%\Documents\Visual Studio 18\Code Parçacıklar\Visual Basic\Kod Parçacıklarım
    • %USERPROFILE%\Documents\Visual Studio 2022\Code Parçacıklar\Visual C#\Kod Parçacıklarım
    • %USERPROFILE%\Documents\Visual Studio 2022\Code Parçacıklar\Visual Basic\Kod Parçacıklarım
  5. C# veya Visual Basic projesi açarak kod parçacığınızı test edin. Düzenleyicide bir kod dosyası açıkken aşağıdaki eylemlerden birini gerçekleştirin:

    • Visual Studio menü çubuğundaIntelliSense>Kod Parçacığı Ekle'yi düzenle'yi> seçin.
    • Sağ tıklayın ve bağlam menüsünden>Kod Parçacığı Ekle seçin.
    • Klavyeden Ctrl+K, X tuşlarına basın.
  6. Kod Parçacıklarım'ı açın ve Kare Kök adlı kod parçacığına çift tıklayın. Kod parçacığı kod dosyasına yerleştirilir.

Açıklama ve kısayol alanları

Açıklama alanı, Kod Parçacıkları Yöneticisi'nde görüntülendiğinde kod parçacığınız hakkında daha fazla bilgi sağlar. Kısayol, kod parçacığınızı eklemek için yazabileceğiniz bir etikettir.

  1. Kod parçacığınızı düzenlemek için kod diline bağlı olarak aşağıdaki konumlardan birinden kod parçacığı dosyasını açın:

    • %USERPROFILE%\Documents\Visual Studio 18\Code Snippets\Visual C#\Kod Parçacıklarım/SquareRoot.snippet
    • %USERPROFILE%\Documents\Visual Studio 18\Code Snippets\Visual Basic\My Code Snippets/SquareRoot.snippet
    • %USERPROFILE%\Documents\Visual Studio 2022\Code Snippets\Visual C#\My Code Snippets/SquareRoot.snippet
    • %USERPROFILE%\Documents\Visual Studio 2022\Code Snippets\Visual Basic\My Code Snippets/SquareRoot.snippet

    Tip

    Dosyayı Visual Studio'nun yerleştirdiği dizinde düzenlediğiniz için, dosyayı Visual Studio'ya yeniden aktarmanız gerekmez.

  2. Author, Description ve Shortcut öğelerini Header öğesine ekleyin ve doldurun.

  3. öğesinin Header aşağıdaki örneğe benzer göründüğünü onaylayın ve dosyayı kaydedin.

    <Header>
        <Title>Square Root</Title>
        <Author>Myself</Author>
        <Description>Calculates the square root of 16.</Description>
        <Shortcut>sqrt</Shortcut>
    </Header>
    
  4. Visual Studio Code Kod Parçacıkları Yöneticisi'ni açın ve kod parçacığınızı seçin. Sağ bölmede Açıklama, Yazar ve Kısayol alanlarının doldurulduğunu görebilirsiniz.

    Kod Parçacığı Yöneticisi'nde kod parçacığı açıklamasını gösteren ekran görüntüsü.

    Kod Parçacığı Yöneticisi'nde kod parçacığı açıklamasını gösteren ekran görüntüsü.

  5. Kısayolu test etmek için daha önce kullandığınız projeyi açın, düzenleyiciye sqrt yazın ve Visual Basic için Sekme tuşuna bir kez veya C# için iki kez basın. Kod parçacığı eklenir.

Değiştirme parametreleri

Kullanıcının kod parçacığının bölümlerini değiştirmesini isteyebilirsiniz. Örneğin, kullanıcının bir değişken adını geçerli projesindeki bir adla değiştirmesini isteyebilirsiniz.

İki tür değiştirme sağlayabilirsiniz: literal ifadeler ve nesneler.

  • Kod parçacığının içinde tamamen yer alan kodun yerini belirlemek ve koda eklendikten sonra özelleştirilmesine olanak tanımak için Literal öğesini kullanın. Örneğin, bir dize veya sayısal değer.

  • Kod parçacığının gerektirdiği ancak büyük olasılıkla kod parçacığının dışında tanımlanmış bir öğeyi tanımlamak için Object öğesini kullanın. Örneğin, bir nesne örneği veya denetim.

Kullanıcıların hesaplamak istedikleri sayının karekökünü kolayca değiştirmelerine yardımcı olmak için SquareRoot.snippet dosyasında bir Literal öğesini kullanabilirsiniz.

  1. SquareRoot.snippet dosyasında Snippet öğesini aşağıdaki gibi değiştirin:

    <Snippet>
      <Code Language="CSharp">
        <![CDATA[double root = Math.Sqrt($Number$);]]>
      </Code>
      <Declarations>
        <Literal>
          <ID>Number</ID>
          <ToolTip>Enter the number you want the square root of.</ToolTip>
          <Default>16</Default>
        </Literal>
      </Declarations>
    </Snippet>
    

    Literal değiştirmenin bir kimlik, Number aldığını fark edin. Kod parçacığında o kimliğe, onu $ karakterleriyle çevreleyerek şu şekilde başvurursunuz:

    <![CDATA[double root = Math.Sqrt($Number$);]]>
    
  2. Kod parçacığı dosyasını kaydedin.

  3. Bir proje açın ve kod parçacığını ekleyin.

    Kod parçacığı eklenir ve değiştirilecek düzenlenebilir değişmez değer vurgulanır. Değeri görmek için, değiştirme parametresinin üzerine gelin ve araç ipucunu görün.

    Visual Studio'da kod parçacığı değiştirme parametresi araç ipucunun ekran görüntüsü.

    Tip

    Kod parçacığında birden fazla değiştirilebilir parametre varsa, değerleri değiştirmek üzere bir parametreden diğerine gitmek için Sekme tuşuna basabilirsiniz.

Ad alanını içeri aktarma

Bir kod parçacığı kullanarak Imports öğesini ekleyerek bir using yönergesi (C#) veya Imports deyimi (Visual Basic) ekleyebilirsiniz. .NET Framework projeleri için References öğesini kullanarak projeye bir başvuru da ekleyebilirsiniz.

Aşağıdaki XML, File.Exists yöntemini System.IO ad alanında kullanan ve bu nedenle System.IO ad alanını içe aktarmak için Imports öğesini tanımlayan bir kod parçacığını gösterir.

<?xml version="1.0" encoding="utf-8"?>
<CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
  <CodeSnippet Format="1.0.0">
    <Header>
      <Title>File Exists</Title>
      <Shortcut>exists</Shortcut>
    </Header>
    <Snippet>
      <Code Language="CSharp">
        <![CDATA[var exists = File.Exists("C:\\Temp\\Notes.txt");]]>
      </Code>
      <Imports>
        <Import>
          <Namespace>System.IO</Namespace>
        </Import>
      </Imports>
    </Snippet>
  </CodeSnippet>
</CodeSnippets>