Útmutató: Kódrészlet létrehozása a Visual Studióban

A hatékonyságot és a megbízhatóságot kódrészletek használatával növelheti, így csökkentheti az ismétlődő kód beírásával vagy a minták keresésével töltött időt. A kódrészletek olyan előre összeállított kódrészletek, amelyek készen állnak az alkalmazásba való beszúrásra.

Létrehozhat saját kódrészleteket, és hozzáadhatja őket a Visual Studio által már tartalmazott kódrészletekhez. Ez a cikk néhány lépésben bemutatja, hogyan hozhat létre kódrészletet. Létrehozhat egy XML-fájlt, kitöltheti a megfelelő elemeket, és hozzáadhatja a kódot a fájlhoz. Szükség esetén helyettesítő paramétereket és projekthivatkozásokat is használhat. Ezután importálja a kódrészletet a Visual Studio-telepítésbe.

Kódrészlet létrehozása

1. Nyissa meg a Visual Studiót, és válassza a Folytatás kód nélkül lehetőséget a kezdőképernyőn .

   

2. A menüsávon válassza azÚj fájlfájlja> lehetőséget, vagy írja be a CtrlNbillentyűkombinációt+.

3. Az Új fájl párbeszédpanelen válassza az XML-fájl, majd a Megnyitás lehetőséget.

   

4. Illessze be a következő egyszerű kódrészletsablont a kódszerkesztőbe.

   <?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. Írja be a cím négyzetgyökét a kódrészlet Title elemébe.

6. Language Az elem attribútumában töltse ki a CodeCSharp függvényt egy C# kódrészlethez vagy a Visual Basichez készült VB-hez.

   Jótanács

   Az összes elérhető nyelvi érték megtekintéséhez tekintse meg a Kódrészletek sémahivatkozás attribútumait.

7. Adja hozzá az alábbi kódrészletet az CDATACode elemen belüli szakaszhoz.

   C#esetén:

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

   Visual Basic esetén:

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

   Megjegyzés:

   A kódrészletek szakaszában nem adhatja meg a CDATA kódsorok formázását és behúzását. A beszúráskor a nyelvi szolgáltatás automatikusan formázja a beszúrt kódot.

8. Mentse a kódrészletet a SquareRoot.snippet fájlba.

A kódrészlet importálása

1. Ha importálni szeretné a kódrészletet a Visual Studio-telepítésbe, válassza az Eszközök>kódrészletek kezelője lehetőséget, vagy nyomja le a CtrlK, Bbillentyűkombinációt+.

2. A Kódrészletek kezelőjében válassza az Importálás gombot.

3. Keresse meg a kódrészlet helyét, jelölje ki, majd válassza a Megnyitás lehetőséget.

4. A Kódrészlet importálása párbeszédpanelen válassza a Jobb oldali panelEn a Saját kód kódrészletek mappát. Válassza a Befejezés, majd az OK lehetőségeket.

   A kódrészletet a kódnyelvtől függően a program a következő helyek egyikére másolja:

   • %USERPROFILE%\Documents\Visual Studio 2022\Code Snippets\Visual C#\My Code Snippets
   • %USERPROFILE%\Documents\Visual Studio 2022\Code Snippets\Visual Basic\My Code Snippets

5. Tesztelje a kódrészletet egy C# vagy Visual Basic projekt megnyitásával. Ha meg van nyitva egy kódfájl a szerkesztőben, hajtsa végre az alábbi műveletek egyikét:

   • A Visual Studio menüsávján válassza azIntelliSense>beszúrási kódrészlet szerkesztése> lehetőséget.
   • Kattintson a jobb gombbal, és válassza a Helyi menü Kódrészlet>beszúrása parancsát .
   • A billentyűzeten nyomja le a CtrlK, X billentyűkombinációt+.

6. Nyissa meg a Saját kódrészleteket, és kattintson duplán a Négyzetgyök nevű kódrészletre. A kódrészlet kódja be lesz szúrva a kódfájlba.

Leírás és billentyűparancsmezők

A leírás mező további információt nyújt a kódrészletről a Kódrészletek kezelőjében való megtekintéskor. A parancsikon egy olyan címke, amelyet beírhat a kódrészlet beszúrásához.

1. A kódrészlet szerkesztéséhez nyissa meg a kódrészletfájlt a kódnyelvtől függően az alábbi helyek egyikéről:

   • %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

   Jótanács

   Mivel a fájlt abban a könyvtárban szerkeszti, amelyben a Visual Studio elhelyezte, nem kell újraimportálnia a Visual Studióba.

2. Adjon hozzá Author, Descriptionés Shortcut elemeket az Header elemhez, és töltse ki őket.

3. Győződjön meg arról, hogy az Header elem az alábbi példához hasonlóan néz ki, és mentse a fájlt.

   <Header>
       <Title>Square Root</Title>
       <Author>Myself</Author>
       <Description>Calculates the square root of 16.</Description>
       <Shortcut>sqrt</Shortcut>
   </Header>
   

4. Nyissa meg a Visual Studio Code Kódrészletek kezelőjét , és válassza ki a kódrészletet. A jobb oldali panelen figyelje meg, hogy a Leírás, a Szerző és a Parancsikon mező már ki van töltve.

   

5. A parancsikon teszteléséhez nyissa meg a korábban használt projektet, írja be a szerkesztőbe a sqrt parancsot , és nyomja le egyszer a Tab billentyűt a Visual Basichez, vagy kétszer a C#-hoz. A kódrészlet be lesz szúrva.

Csereparaméterek

Előfordulhat, hogy azt szeretné, hogy a felhasználó lecserélje egy kódrészlet részeit. Előfordulhat például, hogy azt szeretné, hogy a felhasználó lecseréljen egy változónevet az aktuális projekt egyikére.

Kétféle cseretípust adhat meg: literálokat és objektumokat.

• A Literál elem használatával azonosíthatja a kódrészletben teljes egészében megtalálható kód cseréjét, amely a kódba való beszúrás után testre szabható. Például egy sztring vagy numerikus érték.

• Az Objektum elem használatával azonosíthat egy elemet, amelyet a kódrészlet igényel, de valószínűleg a kódrészleten kívül van definiálva. Például egy objektumpéldányt vagy vezérlőelemet.

A SquareRoot.snippet fájl egyik Literal elemével egyszerűen módosíthatja a számot a négyzetgyök kiszámításához.

1. A SquareRoot.snippet fájlban módosítsa az elemet az Snippet alábbiak szerint:

   <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>
   

   Figyelje meg, hogy a literális csere egy azonosítót kap. Number A kódrészletben szereplő azonosítóra úgy hivatkozhat, hogy karaktereket $ tartalmaz, az alábbiak szerint:

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

2. Mentse a kódrészletfájlt.

3. Nyisson meg egy projektet, és szúrja be a kódrészletet.

   A program beszúrja a kódrészletet, és a szerkeszthető literál ki van emelve csere céljából. Vigye az egérmutatót a csereparaméter fölé az érték elemleírásának megtekintéséhez.

   

   Jótanács

   Ha egy kódrészletben egynél több cserélhető paraméter található, a Tab billentyűt lenyomva válthat az egyik paraméterről a másikra az értékek módosításához.

Névtér importálása

Egy kódrészlet használatával hozzáadhat egy using direktívát (C#) vagy Imports utasítást (Visual Basic) az Import elem hozzáadásával. .NET-keretrendszer-projektek esetén a Hivatkozások elem használatával is hozzáadhat egy hivatkozást a projekthez.

Az alábbi XML egy kódrészletet jelenít meg, amely a névtérben használja a System.IO metódustFile.Exists, ezért meghatározza a Imports névtér importálásához System.IO használt elemet.

<?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>

Kapcsolódó tartalom

• A Visual Studio IntelliSense Code Snippet XML-sémahivatkozását lásd: Kódrészletek sémahivatkozása.
• A Visual Studio Code kódrészleteinek létrehozásáról a Saját kódrészletek létrehozása című témakörben olvashat.