.NET kod analizi kuralları için belgeler katkıda bulunun

.NET derleyici platformu (Roslyn) çözümleyicileri C# veya Visual Basic kodunuzu kod kalitesi ve kod stili sorunları açısından inceler. Bu çözümleyiciler .NET SDK'sı ile birlikte sunulur.

• Kod kalitesi analizi ("CAxxxx" kuralları):
  • dotnet/sdk deposunda (önceden depoda dotnet/roslyn-analyzers uygulandı) uygulanır.
  • Buradadotnet/docs repoda belgelenmiştir. 'CAxxxx' kuralları için bkz. Katkıda bulunma belgeleri.
• Kod stili analizi ("IDExxxx" kuralları):
  • dotnet/roslyn deposunda uygulanır.
  • Buradadotnet/docs depoda belgelendi. 'IDExxxx' kuralları için bkz. Katkıda bulunma belgeleri.

'CAxxxx' kuralları için belgelere katkıda bulunma

Dotnet/docs deposuna kod kalitesi analizi kurallarının belgelerine katkıda bulunmak için lütfen aşağıdaki adımları izleyin:

1. Belirleme Rule ID ve Category: Kuralın belgelenebilmesi için 'CAxxxx' kural kimliğini ve kategorisini bildiğinizden emin olun. Bu, ya CA analizörünüzün dotnet/sdk deposuyla birleştirildiği ya da kurala atanmış onaylanmış bir kimliğe ve kategoriye sahip açık bir PR'ye sahip olduğunuz anlamına gelir.
2. Kural belgesi ekle:
   1. Root klasörü altında yer alan bir CA kural dosyasını klonlayıp yeniden adlandırın.
   2. Dosyanın içeriğini uygun şekilde güncelleştirin.
3. Aşağıdaki tablolara kural için bir girdi ekleyin:
   • İçindekiler tablosu dosyasında, kural kategorisi listesi altında bulunur. Örneğin, kategoriye sahip Performance bir CA kuralı için, dosyada terimi - name: Performance rules arayın ve listeye bir girdi ekleyin. Eğer yoksa, - name: Code quality rules altında yeni bir kategori listesi oluşturun.
   • Üst düzey kural dizin dosyasında.
   • category tabanlı kural dizin dosyasında:
     1. Kök klasör altındaki kategori tabanlı dizin dosyasını tanımlayın. Örneğin, kategoriye sahip Performance bir CA kuralı için bu dosya olarak adlandırılır performance-warnings.md. Mevcut bir dosyayı klonlayarak yeni bir kategoriye dayalı dizin dosyası oluşturun, eğer yoksa.
     2. Bu dosyaya kural kimliği için bir girdi ekleyin.

'IDExxxx' kuralları için belgelere katkıda bulunma

Dotnet/docs deposuna kod stili çözümleme kurallarının belgelerine katkıda bulunmak için lütfen aşağıdaki adımları izleyin:

1. Varsa stil seçeneklerini belirleyin Rule ID ve kodlayın: Kuralın belgelenebilmesi için 'IDExxxx' kural kimliğini ve kod stili seçeneklerini bildiğinizden emin olun. Bu, ya IDE analizörünün dotnet/roslyn deposuna birleştirildiği ya da onaylanmış bir kimlik ve kurala atanmış kod stili seçenekleri ile açık bir çekme isteğiniz olduğu anlamına gelir.
2. Kuralı subcategorybelirleme: IDE kurallarının kategorisi Stylevardır. Kod stili kurallarının giriş bölümünü okuyarak kural alt kategorisini tanımlayın. IDE kod stili kurallarının çoğu alt kategori altındadır Language .
3. Kuralı preference groupbelirleme: preference group tercihler üst bilgilerini okuyarak kuralın değerini belirleyin.
   • Kural bilinen, ilişkili kod stili seçeneklerine sahipse, tercihler grubu kod stili seçenek bildiriminde belirtilenle eşleşecektir OptionGroup .
   • Aksi takdirde, kuralın mevcut bir tercih grubuna mı ait olduğunu yoksa yeni bir tercih grubuna mı ihtiyacı olduğunu belirleyin.
4. Kural belgesi ekle:
   1. Kök klasörünün altında var olan bir IDE kural dosyasını kopyalayıp, örneğin ide0011.md olarak yeniden adlandırın.
   2. Dosyanın içeriğini uygun şekilde güncelleştirin.
5. Aşağıdaki tablolara IDE kuralı ve/veya kod stili seçenekleri için bir girdi ekleyin:
   • kuralın alt kategorisi ve tercihler listesinin altındaki içindekiler tablosunda. Örneğin, alt kategorisi ve grubu olan Language bir IDE kod stili kuralı için, dosyada terimi Modifier preferences ve alt düğümü - name: Language rules arayın ve listeye bir girdi - name: Modifier preferences ekleyin. Alt kategori listesi veya alt kategorinin altındaki tercihler listesi bulunmuyorsa, altında - name: Code style rules yeni bir listesi oluşturun.
   • Kod stili seçenek tabanlı dizin dosyasında.
   • Kural kimliği tabanlı dizin dosyasında.
   • preferences group tabanlı kural dizin dosyasında:
     1. Kök klasör altındaki tercihler grubu tabanlı dizin dosyasını belirleyin. Örneğin, Modifier preferences için bir IDE kuralı için bu dosyanın adı modifier-preferences.md olarak adlandırılır. Hiçbiri yoksa, mevcut bir dosyayı kopyalayarak yeni bir tercihler grubu tabanlı dizin dosyası oluşturun.
     2. Bu dosyaya kural kimliği için bir girdi ekleyin.

Ayrıca bakınız

• .NET belge depolarına katkıda bulunma