Dela via

Kodfragment och hur du använder dem

Kodfragment är små block med återanvändbar kod som du kan lägga till i en kodfil. Kodfragment innehåller vanligtvis ofta använda kodblock som Try...Finally eller If...Else block. Du kan också använda kodfragment för att lägga till hela klasser eller metoder.

Ett kodfragment har en rubrik som du använder för att välja kodfragmentet och kan ha ett genvägsnamn som du kan skriva för att infoga kodfragmentet. Kodfragment kan också innehålla ersättningsparametrar som fungerar som platshållare. Kodfragment är tillgängliga för många språk, inklusive C#, C++ och Visual Basic.

Expansionsfragment och omgiv-med-kodfragment

Du kan lägga till två typer av kodfragment i koden:

  • Ett expansionsfragment läggs till vid en angiven insättningspunkt.
  • Ett omslutningskodfragment läggs till runt den valda koden och är endast tillgängligt för C# och C++.

Hitta tillgängliga kodfragment

Om du vill visa tillgängliga kodfragment för ett språk väljer du Verktyg>Kodfragmenthanteraren i menyraden eller trycker på Ctrl+K, B och väljer sedan det språk du vill använda i listrutan.

Skärmbild av dialogrutan Kodfragmenthanteraren.

Information om hur du skapar och importerar ett eget kodfragment så att det visas i kodfragmentlistan finns i Genomgång: Skapa ett kodfragment i Visual Studio.

Lägga till ett kodfragment i en kodfil

Så här lägger du till ett kodfragment i en kodfil:

  1. I kodredigeraren placerar du markören eller väljer C# eller C++-kod där du vill lägga till kodfragmentet.

  2. Välj en av följande åtgärder:

    • På menyraden i Visual Studio väljer du Redigera>IntelliSense>Insert-kodfragment eller Redigera>IntelliSense>Surround Med.
    • Högerklicka och välj Snippet>Infoga Snippet eller Snippet>Omge med på snabbmenyn.
    • Från tangentbordet trycker du på tangenterna Ctrl+K, X för ett utökningskodfragment eller Ctrl+K, S för ett omgivningskodfragment.

  3. Dubbelklicka på det kodfragment som du vill använda i listrutan, eller skriv genvägen till kodfragmentet och tryck på Tabb eller Retur.

Lägg till ett expansionsfragment

Till exempel lägger C#-expansionsfragmentet tryf till följande Try...Finally block:

try
{

}
finally
{

}

Så här lägger du till det här expansionsfragmentet:

  1. Placera markören i kodredigeraren där du vill lägga till kodfragmentet.
  2. Högerklicka och välj Infoga kodfragment från snabbmenyn, eller använd menyraden eller tangentbordskommandon.
  3. Öppna mappen Visual C# och dubbelklicka sedan på tryf i listrutan, eller välj tryf och tryck på Tabb eller Retur.

Tips/Råd

Du kan också placera markören vid insättningspunkten, skriva tryf och sedan trycka på Tabb två gånger.

Lägg till ett omslutningskodfragment

I följande exempel på ett C++-kodfragment kan genvägen if användas antingen som ett infogningsfragment eller ett omslutningsfragment. Om du väljer kodraden return FALSE; och sedan väljer Omge med>om expanderas kodfragmentet runt raden.

if (true)
{
    return FALSE;
}

Ersättningsparametrar för kodfragment

Kodfragment kan innehålla ersättningsparametrar, som är platshållare som du måste ersätta för att passa koden du skriver. I föregående exempel true är en ersättningsparameter som du ersätter med lämpligt villkor. Ersättningen upprepas för varje instans av ersättningsparametern i kodfragmentet.

Visual Basic har till exempel ett kodfragment som definierar en egenskap. Infoga kodfragmentet:

  1. I snabbmenyn för högerklicka i en Visual Basic-kodfil väljer du Kodfragment>Infoga kodfragment.
  2. Välj Egenskaper för kodmönster>, procedurer, händelser>Definiera en egenskap.

Skärmbild av kodfragmentmenyn för Definiera en egenskap.

Följande kod infogas:

Private newPropertyValue As String
Public Property NewProperty() As String
    Get
        Return newPropertyValue
    End Get
    Set(ByVal value As String)
        newPropertyValue = value
    End Set
End Property

Om du ändrar newPropertyValue till m_property, ändras varje instans av newPropertyValue. Om du ändrar String till Int i egenskapsdeklarationen ändras även värdet i Set metoden till Int.

Metodtips för att använda kodfragment

Koden i ett kodfragment visar bara det mest grundläggande sättet att göra något. För de flesta program måste koden ändras så att den passar programmet.

Hantering av undantag

Vanligtvis fångar och återkastar kodsnippets Try...Catch-block alla undantag, men det kanske inte är rätt val för ditt projekt. För varje undantag finns det flera sätt att svara på. Exempel finns i Hantera ett undantag med try/catch (C#) och Try...Catch...Finally-uttalande (Visual Basic).

Filplatser

När du anpassar filplatser till ditt program bör du tänka på följande faktorer.

  • Hitta en tillgänglig plats. Användare kanske inte har åtkomst till datorns Program Files-mapp , så att lagra användarfiler med programfilerna kanske inte fungerar.

  • Hitta en säker plats. Lagring av filer i rotmappen som C:\ är inte säkert. För programdata är det bäst att använda mappen Programdata . För enskilda användardata kan programmet skapa en fil i varje användares dokumentmapp.

  • Använd ett giltigt filnamn. Du kan använda OpenFileDialog kontrollerna och SaveFileDialog för att minska sannolikheten för ogiltiga filnamn.

  • Tänk på att en användarvald fil kan tas bort innan koden kan ändra filen. En användare kanske inte heller har behörighet att skriva till filen.

Säkerhet

Säkerheten för ett kodfragment beror på var du använder det i källkoden och hur du ändrar det när det finns i koden. Följande lista innehåller några områden att tänka på:

  • Fil- och databasåtkomst
  • Kodåtkomstsäkerhet
  • Skydda resurser som händelseloggar och register
  • Lagra hemligheter
  • Verifiera inmatningar
  • Skicka data till skripttekniker

Mer information finns i Säkra program.

Nedladdade kodfragment

Kodfragment som installeras av Visual Studio är inte själva säkerhetsrisker. De kan dock skapa säkerhetsrisker i ditt program. Kodfragment som laddas ned från Internet bör behandlas med extrem försiktighet, precis som andra nedladdade innehåll. Ladda endast ned kodfragment från webbplatser som du litar på och använd up-to-date virusprogramvara.

Öppna alla nedladdade kodfragmentfiler i Anteckningar eller XML-redigeraren i Visual Studio och granska dem noggrant innan du installerar dem. Se upp för följande problem:

  • Kodfragment som kan skada systemet om du kör det. Läs källkoden noggrant innan du kör den.

  • HelpURL block i kodfragmentfiler som innehåller URL:er som kör skadliga skriptfiler eller visar stötande webbplatser.

  • Kodfragment som innehåller referenser som läggs till tyst i projektet och som kan läsas in var som helst i systemet. Du kan ladda ned dessa referenser från samma plats som du laddar ned ett kodfragment från. Kodfragmentet kan sedan anropa en metod i referensen som kör skadlig kod. Om du vill identifiera sådana referenser granskar du blocken Imports och References i kodfragmentfilen.

Relaterat innehåll