Görsel stüdyoda otomatik olarak işlev başlıkları oluşturmanın bir yolu (umarım klavye kısayolu) olup olmadığını merak ediyordum.
Misal:
Private Function Foo(ByVal param1 As String, ByVal param2 As Integer)
Ve otomatik olarak böyle bir şeye dönüşürdü ...
'----------------------------------
'Pre:
'Post:
'Author:
'Date:
'Param1 (String):
'Param2 (Integer):
'Summary:
Private Function Foo(ByVal param1 As String, ByVal param2 As Integer)
Yanıtlar:
Bunu "üç tek yorum işaretçisi" yapın
C # 'da ///
varsayılan olarak tükenen:
/// <summary>
///
/// </summary>
/// <returns></returns>
VS şablonlarını düzenlemeyle ilgili bazı ipuçlarını burada bulabilirsiniz .
GhostDoc !
İşleve sağ tıklayın, "Bunu belgeleyin" i seçin ve
private bool FindTheFoo(int numberOfFoos)
olur
/// <summary>
/// Finds the foo.
/// </summary>
/// <param name="numberOfFoos">The number of foos.</param>
/// <returns></returns>
private bool FindTheFoo(int numberOfFoos)
(evet, hepsi otomatik olarak oluşturulmuştur).
C #, VB.NET ve C / C ++ desteği vardır. Varsayılan olarak Ctrl+ Shift+ ile eşleştirilir D.
Unutmayın: belgelere yöntem imzasının ötesinde bilgiler eklemelisiniz. Otomatik olarak oluşturulan belgelerle yetinmeyin. Bunun gibi bir aracın değeri, yöntem imzasından çıkarılabilen belgeleri otomatik olarak oluşturmasıdır, bu nedenle eklediğiniz tüm bilgiler yeni olmalıdır. bilgiler .
Bununla birlikte, ben şahsen yöntemlerin tamamen kendi kendine belgelenmesini tercih ederim, ancak bazen dışarıdan dokümantasyonu zorunlu kılan kodlama standartlarına sahip olursunuz ve sonra bunun gibi bir araç sizi çok fazla beyinsiz yazmadan kurtarır.
///
Yöntem Açıklaması yorum bloğunu almak için kısayol. Ancak eklemeden önce işlev adını ve imzasını yazdığınızdan emin olun. Önce İşlev adını ve imzasını yazın.
Ardından, işlev adının üzerine sadece /// yazın.
ve otomatik olarak alacaksın
Visual Assist'in de güzel bir çözümü var ve oldukça kostümlü.
Doxygen tarzı yorumlar oluşturmak için ince ayar yaptıktan sonra, bu iki tıklama şunu üretecektir:
/**
* Method: FindTheFoo
* FullName: FindTheFoo
* Access: private
* Qualifier:
* @param int numberOfFoos
* @return bool
*/
private bool FindTheFoo(int numberOfFoos)
{
}
(Varsayılan ayarlar altında biraz farklıdır.)
Düzenleme: 'Belge yöntemi' metnini özelleştirmenin yolu VassistX-> Görsel Yardım Seçenekleri-> Öneriler altındadır, 'VA Parçacıklarını Düzenle'yi seçin, Dil: C ++, Tür: Yeniden Düzenleme, ardından' Belge Yöntemi'ne gidin ve özelleştirin. Yukarıdaki örnek şu şekilde oluşturulmuştur:
Normalde, yorum yapmak istediğiniz şeyin (yöntem, sınıf) üstüne üç tek yorum işaretçisi eklerseniz, Visual Studio bunu otomatik olarak oluşturur.
C # 'da bu, /// .
Visual Studio bunu yapmazsa, bunu şuradan etkinleştirebilirsiniz:
Seçenekler-> Metin Düzenleyici-> C # -> Gelişmiş
ve kontrol et
/// için XML dokümantasyon yorumları oluşturun
Visual Basic'te, önce işlevinizi / alt dosyanızı oluşturursanız, ardından üstündeki satıra 'üç kez' yazarsanız, dokümantasyon için ilgili xml'yi otomatik olarak oluşturur. Bu aynı zamanda intellisense'de fareyle üzerine geldiğinizde ve işlevi kullanırken de görünür.
İstediğiniz herhangi bir satırı eklemek için kod parçacıklarını kullanabilirsiniz.
Ayrıca, işlev başlığının üzerindeki satıra üç tek tırnak işareti ('' ') yazarsanız, daha sonra doldurabileceğiniz XML başlık şablonunu ekler.
Bu XML yorumları, dokümantasyon yazılımı tarafından yorumlanabilir ve derleme çıktısına bir assembly.xml dosyası olarak dahil edilir. Bu XML dosyasını DLL ile saklar ve o DLL'ye başka bir projede başvurursanız, bu yorumlar intellisense'de kullanılabilir hale gelir.
Bir dosyayı kaydederken otomatik olarak uygun dokümantasyon çıktısı üretmek için kelimeleri analiz eden Todoc adlı açık kaynaklı bir proje üzerinde çalışıyorum. Mevcut yorumlara saygı duyar ve gerçekten hızlı ve akıcıdır.