Kod Dosyaları Oluşturmak ve Kullanmak

Kod Dosyaları Oluşturmak ve Kullanmak
Visual Web Developer 2005 Express ve Visual Studio 2005 editörleri ile birlikte gelen en yararlı yeni özelliklerden biri de kod parçacıklarını bir dosya şeklinde tanımlayabilmeniz ve bunları daha sonradan kullanabilmenizdir.
Bunu nasıl yapacağımızı bu makalemizde inceleyeceğiz?
Öncelikle kod parçacıkları ne demektir?
İngilizcesi “code snippets” olan ufak kod parçacıkları birden fazla yerde pek çok kez kullanılan veya kullanılabilecek küçük faydalı kodlardır.
Bunlar bir class oluşturmaktan, bir login yordamı yaratmaya kadar pek çok amaçlı olabilirler.
Yazılımcı olarak bizler de her seferinde bu kodları baştan tek tek yazmak yerine bir yerden çağırarak, kendi değerlerimizi vererek bir hamlede kullanmak isteriz.

Bu kod parçacıklarını sadece ilgili değişkenleri tanımlayarak doğrudan diğer kodlarınızın içine dâhil edebilirsiniz.
Hatta daha önceden başkaları tarafından oluşturulmuş kodları alıp kullanabilirsiniz.
Gerçekten çok faydalı bir yöntem.
Bu yöntem hem Visual Web Developer 2005 Express de hem de Visual Studio 2005 editöründe kullanılabiliyor.
Editörümüzün tools menüsünden “Code Snippets Manager” a ulaşabiliriz.
Küçük kod parçacıklarımızı yöneteceğimiz arabirim buradan çıkar.
Veya bu menüde göremeyenler için (Visual Studio 2005)  , ctrl+B  ile kısa yoldan ulaşılabilir.


 

Buraya tıkladığınızda aşağıdaki ekran çıkacaktır:

 

Bu pencere kodlarınızı yönettiğiniz penceredir. Ancak öncelikle bir küçük kod dosyası veya İngilizcesiyle “code snippet” dosyası oluşturmalısınız.


Code Snippet Dosyası

Bu dosyalar küçük kodlarınızı oluşturduğunuz, onları tanımladığınız kimliklendirdiğiniz ve code snippets penceresi vasıtasıyla editörünüze dâhil etmeye hazır hale getirdiğiniz özel XML dosyalarıdır. Bu dosyalar XML geçerlilik kurallarına göre oluşturulup, snippet kurallarına göre tag(etiket) tanımları yapılır. Böylece elinizde kullanıma hazır bir kod parçacığı bulunur.

Şimdi bu tarzda oluşturulmuş bir dosyayı aşağıda vereceğim ve sonra detaylarını inceleyeceğiz. Öncelikle bu dosyaların uzantıları .snippet dır;

Deneme.snippet

<?xml version="1.0" encoding="utf-8" ?>
<CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
  <CodeSnippet Format="1.0.0">
    <Header>
      <Title>class tanimi</Title>
      <Shortcut>class kisayol</Shortcut>
      <Description>Class oluşturma </Description>
      <Author>zafer demirkol</Author>
      <SnippetTypes>
        <SnippetType>Expansion</SnippetType>
      </SnippetTypes>
    </Header>
    <Snippet>
      <Declarations>
        <Literal>
          <ID>classad</ID>
          <ToolTip>Class ismi</ToolTip>
          <Default>ornekclass</Default>
        </Literal>
        <Literal>
          <ID>tip</ID>
          <ToolTip>ornek tipi</ToolTip>
          <Default>sablon_class</Default>
        </Literal>
        <Literal>
          <ID>alan</ID>
          <ToolTip>alan</ToolTip>
          <Default>nesnem</Default>
        </Literal>
        <Literal>
          <ID>metot</ID>
          <ToolTip>metot getir</ToolTip>
          <Default>metot</Default>
        </Literal>
      </Declarations>
      <Code Language="csharp">
        <![CDATA[class $classad$
          {
            static private $classad$ $alan$ = null;           
            protected $classad$()
            {
            }
            public static $classad$ $metot$()
            {
                 if ($alan$ == null)
                     $alan$ = new $classad$();
                 return $alan$;
            }
          }]]>
        </Code>
      </Snippet>
    </CodeSnippet>
    </CodeSnippets>




Gördüğünüz gibi bu bir XML dosyasıdır. Bu dosyada kullanacağımız kodları yazacağımız kısım <Code> arasında belirttiğimiz alandır.
Ancak işimiz bununla bitmiyor. Bu kod parçacığımıza kimlik kazandıracak, onu tanımlayacak bazı ek bildirimleri yapmalıyız.
Bunlar da yine özel XML Tagları arasında yapılır.
Örneğin <Title> tagıyla kodumuzun etiketini veriyoruz.
Bu etiket kod parçacığımızı editörümüzde kullanmak istediğimizde bize gözükecektir.
<Shortcut> ile kod parçacığımızın kısa yol tanımını, <Description> ile kod parçamızın açıklamasını yaparız.

Bütün bunları kod parçacığını editörümüze dâhil ettiğimizde –ki birazdan bunun nasıl olacağını anlatacağım- sağ tıklayarak görebiliriz:

 

Ekran görüntüsünden de kolayca izlendiği gibi bu Taglarda verdiğimiz tanımlar editörümüzde açıklayıcı notlar olarak gözükmekte….

Snippet dosyamızı incelemeye devam edersek, <Declarations> alanlarını görürüz.
Bu alanlar değişkenlerin oluşturulduğu alanlardır. Kendi içinde birkaç tipi mevcuttur ancak bunların en çok kullanılanı “literal” tiptir.
Peki değişken deklarasyonu ne demektir bir kod parçacığında?
Anımsayacağınız gibi küçük kod parçacıklarını, projemize ait değerlerle kullanabileceğimizi yukarıda yazmıştım.
Örneğimizde olduğu gibi class oluşturan bir kod parçacığını class ismini class ı kullanan kişice oluşturulmasını sağlayacak şekilde yapabiliriz.
Böylece küçük kod parçacığımız istenilen şekilde özelleştirilebilir. Bu da ancak değişken tanımlarını belirterek yapılabilir. Daha doğru bir ifadeyle, değişebilecek yerleri deklare etmekle (belirtmekle)  yapılabilir. İşte bu tanımlarda  <Declarations>   kısmında oluşturulur.
Böylece bu küçük kod parçacığını kullanan yazılımcı kolayca, değişken alanları fark eder ve kendine göre düzenler.
<Code Language="csharp"> değerini de yazdığımız dile göre VB veya csharp olarak atayabiliriz.

Kod Parçacıklarını Kullanmak
Yukarıdaki gibi bir snippet dosyası oluşturduktan sonra sıra bu kod parçacığını editörümüze tanıtmaya gelir.
Bu haliyle editörümüzün kod dosyasından haberi olamaz.
Bunun için yukarda gördüğümüz Code Snippets Manager… ı kullanırız.

Bu arabirimde iki temel işlevi gerçekleştirebiliyoruz.
Bunlardan ilki klasör veya klasörleri kod snippet klasörü olarak belirleyebiliyoruz.
İkincisi bu klasöre, oluşturduğumuz snippet dosyasını ekleyebiliyoruz.
Klasörü tanımlamak için add… Butonuna tıklayarak bilgisayarımızdaki her hangi bir klasör yol tanımını belirtiyoruz.
Böylece o klasör artık projelerimizde kullanacağımız kod parçacıklarımızın barındığı klasör olacaktır ve editörümüzün kod tamamlama kısmında gözükecektir.
Klasör oluşturmakla işimiz bitmiyor, bu arabirim sayesinde snippet dosyamızı klasöre dâhil (import) etmemiz gerekiyor. Bu işlemi, geleneksel yolla dosyayı bulup sürükle bırakla yapamayız, snippet’ın editör tarafından tanınması için buradan yapmalıyız.

Bunun için import… butonuna tıklayarak snippet dosyamızı bulup editörümüze dahil etmeliyiz.
Pek çok .snippet uzantılı dosyayı oluşturup (veya temin edip) editörümüze bu şekilde dahil edebiliriz.
Yapmamız gerekenler bu kadar.
Artık kod parçacığımız kullanıma hazır.

Kod Parçacığını Kodlarımıza Dahil Etmek
Bu işlem gayet basittir. Sayfamız kodlarında her hangi bir yere sağ tıklayıp dâhil edebiliriz:



 

Burada yukarıda snippet dosyamızda yaptığımız tanımlar gözükmekte.
Kod’umuzu dâhil ettiğimizde aşağıdaki bildirimlerle karşılaşacağız:

 

Gördüğünüz gibi yukarıda deklare ettiğimiz alanlar farklı renkler ve kutucuklarla işaretlenmiş. Bu alanları kendi kodlarınıza göre değiştirebilirsiniz. Veya bu şekliyle tanımlı (default ) değerleriyle bırakabilirsiniz.

Visual Web Developer 2005 Express ve Visual Studio 2005 kod parçacıkları oluşturup kullanmak bu kadar basittir.