GitHub Copilot "açıklama" ve "belge" özelliklerini gözden geçirin

  • 5 dakika

GitHub Copilot geliştiricilerin karmaşık veya tanıdık olmayan kodlarla çalışmasını kolaylaştırır. Visual Studio Code'da geliştiriciler, kodu analiz eden, açıklayan veya belgeleyen GitHub Copilot özelliklere doğrudan erişebilir.

GitHub Copilot kullanarak kodu analiz etme ve açıklama

Kodu analiz etmek ve açıklamak için aşağıdaki GitHub Copilot özellikleri kullanılabilir:

  • Soru modu: Tüm çalışma alanınızı analiz etmek ve kodlama konuları, teknoloji kavramları ve genel programlama uygulamaları hakkında sorular sormak için Sohbet görünümünü ask modunda kullanın.

  • Satır içi Sohbet: Belirli kod bölümleri hakkında bilgi almak için doğrudan düzenleyiciden satır içi sohbet oturumu başlatın.

  • Akıllı Eylemler: Bir istem yazmak zorunda kalmadan seçili kodu açıklamak için Akıllı açıklama eylemini çalıştırın.

  • Hızlı Sohbet: Hızlı bir soru sorun ve yaptığınız şeye geri dönün.

GitHub Copilot kullanarak satır içi kod belgeleri oluşturma

Satır içi kod belgeleri oluşturmak için aşağıdaki GitHub Copilot özellikleri kullanılabilir:

  • Soru modu: Bir kod dosyası, sınıfı veya yöntemi için satır içi kod belgeleri önermek için Aracıya sor modunu kullanın. Sohbet görünümünde önerilen satır içi belgeleri gözden geçirin. Sohbet konuşmasında gerektiğinde güncelleştirme isteyin. Önerilen belgelerle yetindikten sonra, önerilen belgeleri ilgili kod dosyasına ekleyebilirsiniz.

  • Plan modu: Belge görevleriniz için ayrıntılı bir uygulama planı oluşturmak için Plan modunu kullanın. Plan modu, kod tabanını analiz etmek, belge gereksinimlerini tanımlamak ve adım adım bir plan oluşturmak için kullanılabilir. Plan onayı aldıktan sonra, çalıştırmak için Agent mode'a devredebilirsiniz.

  • Aracı modu: Belirtilen kod projeleri, dosyalar, sınıflar veya yöntemler için satır içi kod belgelerini otonom olarak oluşturmak için Aracı modunu kullanın. Belge işlemi sırasında veya sonrasında aracının diğer görevleri gerçekleştirmesini sağlayın. Temsilci atanan görevleri tamamladığında güncellemeleri kabul edin veya reddedin.

  • Satır içi sohbet - Doğrudan kod düzenleyicisinde çalışmak için satır içi sohbet oturumu kullanın. Satır içi sohbet, düzenleyiciden çıkmadan belirli kodları (sınıflar, yöntemler veya kod blokları) belgelediğinizde kullanışlıdır. İstemde belirli yönergeler sağlayabilir veya isterseniz belirli bilgiler olmadan /doc çizgi komutunu kullanabilirsiniz. Güncelleştirmeler kod düzenleyicisinde görüntülenir ve kabul edilebilir veya reddedilebilir. Komutu güncellemeli veya güncellesiz olarak yeniden çalıştırma seçeneğini de belirleyebilirsiniz.

  • Docs akıllı eylemi oluşturma: Seçili sınıf, yöntem veya kod bloğu için satır içi kod belgeleri oluşturmak için Docs akıllı eylemini kullanın. Belge Oluştur akıllı eylemi, istem gerektirecek belirli gereksinimleriniz olmadığında kullanışlıdır. Güncelleştirmeler kod düzenleyicisinde görüntülenir ve kabul edilebilir veya reddedilebilir. Akıllı eylemi de yeniden çalıştırabilirsiniz.

GitHub Copilot kullanarak proje belgeleri oluşturma

Proje belgeleri oluşturmak için aşağıdaki GitHub Copilot özellikleri kullanılabilir:

  • Aracıya sor modunda sohbet görünümü: Kod tabanını analiz etmek ve kod projelerini, dosyalarını ve sınıflarını anlamak için Ask aracısını kullanın. Ask aracısı önerilen proje belgelerini önizlemek için kullanılabilir. Önerileri gözden geçirin ve gerektiğinde güncelleştirmeleri veya diğer ayrıntıları isteyin. Önerilen belgeleri bir proje belge dosyasına (README.md) ekleyin.

  • Plan aracısı modunda sohbet görünümü: Proje belgeleri için ayrıntılı bir uygulama planı oluşturun ve yürütme için aracı moduna iletin.

  • Aracı modunda sohbet görünümü: Proje belge dosyaları koleksiyonu oluşturun: README.md oluşturun/güncelleştirin, UsageExamples.md oluşturun/güncelleştirin ve ChangeLog.md oluşturun/güncelleştirin. Belge dosyaları, çapraz başvuru sınıfları ve yöntemleri arasında bağlantılar ekleyin ve belgeler arasında tutarlılık sağlayın.

Önemli

Aracı modunda Sohbet görünümünü kullandığınızda, girdiğiniz her istem, modelin çarpanı ile çarpılarak tek bir premium istek olarak sayılır. GitHub Copilot görevinizi tamamlamak için birkaç izleme eylemi gerçekleştirebilir, ancak bu izleme eylemleri premium istek kullanımınıza uygun değildir. Yalnızca girdiğiniz istemler faturalandırılır. Kullanılan toplam premium istek sayısı, kaç istem girdiğinize ve modelin seçili olduğuna bağlıdır. GitHub Copilot için Ücretsiz Plan ayda 50 premium istek alır. Her GitHub Copilot aboneliği için premium istek sınırları hakkında daha fazla ayrıntı için plan açıklamalarını denetleyin.

Özet

GitHub Copilot kodunuzu hızlı ve doğru bir şekilde analiz edip belgelediğinize yardımcı olur. Sohbet görünümü, satır içi sohbet, hızlı sohbet ve akıllı eylem özellikleri doğrudan Visual Studio Code ortamı içinde çeşitli etkileşim düzeyleri sağlar.