C # 'da Ticari Proje İçin Hata Kodları Kalıbı Oluşturmak için En İyi Uygulamalar [kapalı]

Birçok KOBİ ve İşletmelerde uygulanacak olan bir işletme projesi üzerinde çalışıyorum.
Bu projeye destek zorlu olacak ve bu yüzden hatalar için bir kodlama kalıbı oluşturmak istiyorum ( HTTP durum kodları gibi ). Bu yardım masası çalışanlarının belgelere başvurmalarını ve problemleri en kısa sürede gidermelerini sağlayacaktır.

Bunu yapmak için en iyi uygulamalar ve öneriler nelerdir?
Bunu yapmak için herhangi bir yardım yararlı olacaktır.

Hata kodları ve hata dönüş değerleri arasında bir fark var. Bir hata kodu kullanıcı ve yardım masası içindir. Bir hata dönüş değeri, kodunuzun bir hatayla karşılaştığını gösteren bir kodlama tekniğidir.

Bir hata dönüş değerleri kullanarak hata kodları uygulayabilirsiniz, ancak buna karşı öneriyorum. İstisnalar, hataları bildirmenin modern bir yoludur ve içinde bir hata kodu taşımamaları için hiçbir neden yoktur.

Bunu nasıl düzenleyeceğim (2-6. Noktaların dilden agnostik olduğuna dikkat edin):

1. Ek bir ErrorCodeözelliğe sahip bir özel istisna türü kullanın . Ana döngüdeki catch, bu alanı her zamanki gibi rapor edecektir (log dosyası / hata açılır / hata yanıtı). Tüm kodlarınızda aynı istisna türünü kullanın.
2. 1'den başlamayın ve baştaki sıfırları kullanmayın. Tüm hata kodlarını aynı uzunlukta tutun, böylece yanlış bir hata kodunu bulmak kolaydır. 1000'den başlamak genellikle yeterlidir. Belki de kullanıcılar için net bir şekilde tanımlanabilir hale getirmek için öncü bir 'E' ekleyin (özellikle de destek masası kullanıcılara hata kodunu nasıl tespit edeceklerini bildirmek için kullanışlıdır).
3. Tüm hata kodlarının bir listesini tutun, ancak bunu kodunuzda yapmayın . Geliştiriciler için yeni bir koda ihtiyaç duyduklarında kolayca düzenleyebilecekleri bir wiki sayfasında kısa bir liste tutun. Yardım masası kendi wikilerinde ayrı bir listeye sahip olmalıdır.
4. Hata kodları üzerinde bir yapı zorlamaya çalışmayın. Her zaman sınıflandırılması zor hatalar olacaktır ve bir hatanın 45xx grubunda mı yoksa 54xx grubunda mı olduğunu saatlerce tartışmak istemezsiniz. Pragmatik olun .
5. Kodunuzdaki her atımı ayrı bir kod atayın. Aynı nedenin sizce de olsa, yardım masasının farklı durumlarda farklı şeyler yapması gerekebilir. Kullanıcıların yanlış yaptıklarını itiraf etmelerini sağlamak yerine, wikilerinde "E1234: E1235'i Gör" ifadesini kullanmak daha kolaydır.
6. Yardım masası isterse hata kodlarını ayırın. if (...) throw new FooException(1234, ".."); else throw new FooException(1235, "..");Kodunuzdaki basit bir çizgi yardım masası için yarım saat tasarruf sağlayabilir.

Ve hata kodlarının amacının yardım masası için hayatı kolaylaştırmak olduğunu asla unutmayın .

İlk önce hataların olabileceği alanları yalıtmanız ve kullanıcı tarafından görülebilir durumda olmanız gerekir. O zaman onları belgeleyebilirsiniz. Bu kadar basit.

Eh, teoride basit .. uygulamada tüm kahrolasıca yerlerde hatalar meydana gelebilir ve bunları rapor etmek, güzel kodları günlüğe kaydetme, istisna atma ve kullanma ve geri dönüş değerlerini geçirme canavarına dönüştürebilir.

O zaman 2 adımlı bir yaklaşım öneririm. Birincisi, günlüğe kaydetme, lotları ve lotları kaydetmektir.

İkincisi, ana bileşenleri ve arayüzlerini belirlemek ve bu bileşenlerin kendilerini bulabilecekleri ana hata durumlarını tanımlamaktır. Bu hatalardan biri (hatayı dahili olarak nasıl idare edeceğinize bağlı olduğunda) daha görünür bir şekilde oturum açabilirsiniz. - istisnalar veya hata kodları burada bir fark yaratmaz). Bir kullanıcı genellikle hatayı görecek ve daha ayrıntılı bilgi için günlüklere gidecektir.

Aynı yaklaşım web sunucuları ve http hata kodu örneğiniz için de kullanılır. Kullanıcı bir 404'ü görür ve desteklediğini bildirirse, neler olup bittiğini, hangi sayfanın ziyaret edildiğini, ne zaman ve ne zaman başka bir anlam ifade edebileceğini öğrenebilecekleri herhangi bir bilgiyi toplayacaktır. , DB, ağ veya uygulamada olmak.

Açıklayıcı isimlerle özel istisnalar arardım ve mesajları temizler ve onları atardım. Bir dilin mevcut istisna altyapısını kullanmak, hata kodlarını dolaşıp yorumlamak için destek oluşturmaktan çok daha kolaydır.