Untuk menggarisbawahi atau untuk tidak menggarisbawahi, itulah pertanyaannya

Apakah ada masalah dengan tidak mengawali bidang pribadi dengan garis bawah dalam C # jika versi biner akan dikonsumsi oleh bahasa kerangka kerja lain? Misalnya karena C # peka huruf besar kecil, Anda dapat memanggil bidang "foo" dan properti publik "Foo" dan berfungsi dengan baik.

Akan ini setiap efek pada bahasa case-sensitive seperti VB.NET, akan ada oleh CLS-kepatuhan (atau lainnya) masalah jika nama hanya dibedakan oleh casing?

Ini akan memiliki tidak berpengaruh.

Bagian dari rekomendasi untuk menulis perpustakaan yang memenuhi CLS adalah untuk TIDAK memiliki dua entitas publik / dilindungi yang berbeda hanya dengan kasus misalnya Anda TIDAK harus memiliki

public void foo() {...}

dan

public void Foo() {...}

apa yang Anda gambarkan bukan masalah karena item pribadi tidak tersedia untuk pengguna perpustakaan

PEMBARUAN PENTING (12 April 2016):

Kami memperhatikan bahwa standar internal tim .NET CoreFX bersikeras menggunakan notasi garis bawah tanpa memberikan wawasan mengapa. Namun jika kita melihat secara dekat aturan # 3 menjadi jelas bahwa ada sistem _, t_, s_prefiks yang menyarankan mengapa _dipilih di tempat pertama.

3. Kami menggunakan _camelCaseuntuk bidang internal dan pribadi dan menggunakan hanya baca jika memungkinkan. Awali bidang contoh dengan _, bidang statis dengan s_dan utas bidang statis dengan t_. Ketika digunakan pada bidang statis, readonlyharus datang setelahnya static(yaitu static readonlytidak readonly static).
4. Kami menghindari this.kecuali benar-benar diperlukan.

Jadi jika Anda seperti tim .NET CoreFX yang mengerjakan beberapa kode level sistem yang kritis, multithreaded, kinerja , maka SANGAT DISARANKAN agar Anda:

• mematuhi standar pengkodean dan
• gunakan notasi garis bawah dan
• jangan baca jawaban ini lebih jauh

Kalau tidak silakan baca terus ...

JAWABAN ASLI:

Pertama-tama mari kita sepakat tentang apa yang kita bicarakan. Pertanyaannya adalah bagaimana kita mengakses anggota instance dari dalam metode dan konstruktor non-statis kelas / sub-kelas jika pengubah visibilitas memungkinkan melakukannya.

Notasi garis bawah

• menyarankan agar Anda menggunakan awalan "_" dalam nama bidang pribadi
• itu juga mengatakan bahwa Anda tidak boleh menggunakan "ini" kecuali jika benar-benar diperlukan

Notasi ini

• menunjukkan bahwa Anda selalu menggunakan "ini." untuk mengakses anggota instance

Mengapa notasi ini ada?

Karena ini adalah bagaimana Anda

• pisahkan parameter dari bidang saat mereka berbagi nama yang sama
• pastikan Anda bekerja dalam konteks instance saat ini

Contoh

public class Demo
{
   private String name;
   public Demo(String name) {
       this.name = name;
   }
}

Mengapa notasi garis bawah itu ada?

Beberapa orang tidak suka mengetik "ini", tetapi mereka masih membutuhkan cara untuk membedakan bidang dan parameter, jadi mereka setuju untuk menggunakan "_" di depan bidang

Contoh

public class Demo
{
   private String _name;
   public Demo(String name) {
      _name = name;
   }
}

Orang mungkin berpikir itu hanya masalah selera pribadi dan keduanya sama-sama baik / buruk. Namun ada beberapa aspek di mana notasi ini mengalahkan notasi garis bawah:

Kejelasan

• menggarisbawahi-notasi nama clutters
• notasi ini membuat nama tetap utuh

Beban kognitif

• notasi garis bawah tidak konsisten, itu membuat Anda memperlakukan bidang dengan cara khusus, tetapi Anda tidak dapat menggunakannya dengan anggota lain, setiap kali Anda perlu bertanya pada diri sendiri apakah Anda memerlukan properti atau bidang

• notasi ini konsisten, Anda tidak perlu berpikir, Anda selalu menggunakan "ini" untuk merujuk ke anggota mana pun

PEMBARUAN: seperti yang ditunjukkan berikut ini bukan poin keuntungan

Pemeliharaan

• notasi garis bawah mengharuskan Anda untuk mengawasi _saat melakukan refactoring, katakanlah mengubah bidang menjadi properti (hapus _) atau sebaliknya (tambahkan _)

• notasi ini tidak memiliki masalah seperti itu

Pelengkapan otomatis

Ketika Anda perlu melihat daftar anggota contoh:

• notasi garis bawah tidak banyak membantu Anda, karena ketika Anda mengetik "_" popup autocomplete menunjukkan kepada Anda bidang pribadi dan semua jenis yang tersedia dari rakitan tertaut yang dicampur dengan anggota instance lainnya
• notasi ini memberi Anda jawaban yang jelas, dengan mengetik "ini" yang Anda lihat hanyalah daftar anggota dan tidak ada yang lain

Kemenduaan

Terkadang Anda harus berurusan dengan kode tanpa bantuan Intellisense. Misalnya ketika Anda melakukan review kode atau menelusuri kode sumber online.

• underscore-notation adalah ambigu: Ketika Anda melihat Sesuatu. Sesuatu yang Anda tidak dapat mengatakan apakah Sesuatu adalah kelas dan SomethingElse adalah properti statisnya ... atau mungkin Sesuatu adalah properti instance saat ini yang memiliki properti sendiri dari SomethingElse

• ini-notasi jelas: Ketika Anda melihat Sesuatu. Sesuatu Itu hanya dapat berarti kelas dengan properti statis dan ketika Anda melihat ini. Sesuatu. Sesuatu yang Anda tahu bahwa Sesuatu adalah anggota dan SesuatuElse adalah miliknya

Metode penyuluhan

Anda tidak dapat menggunakan metode ekstensi pada instance itu sendiri tanpa menggunakan "ini."

• garis bawah-notasi mengharuskan Anda tidak menggunakan "ini", namun dengan metode ekstensi Anda harus
• notasi ini menyelamatkan Anda dari keragu-raguan, Anda selalu menggunakan "ini", titik.

Dukungan Visual Studio

• garis bawah-notasi tidak memiliki dukungan bawaan di Visual Studio

• notasi ini didukung oleh Visual Studio secara alami:

  1. "Ini." Kualifikasi : Memilih semua bidang non-statis yang digunakan dalam metode non-statis untuk diawali dengan this.dalam C #

Rekomendasi resmi

Ada banyak pedoman resmi yang dengan jelas mengatakan "jangan gunakan garis bawah" terutama di C #

• garis bawah-notasi berasal dari C ++ di mana ini adalah praktik umum yang membantu menghindari konflik penamaan, juga direkomendasikan untuk VisualBasic.Net untuk mengatasi masalah di mana bidang "nilai" dan properti "Nilai" sebenarnya memiliki nama yang sama, karena VisualBasic case-insensitive

  1. Menyatakan nama elemen dalam Visual Basic
  2. Bidang dukungan di VisualBasic.NET

• notasi ini direkomendasikan untuk C # sementara "_" secara eksplisit dilarang:

  1. kata kunci ini dalam C #
  2. Pedoman penggunaan bidang : Jangan menerapkan awalan untuk nama bidang atau nama bidang statis.
  3. Pedoman untuk nama: Nama anggota tipe : Jangan gunakan awalan untuk nama bidang.
  4. Konvensi penamaan umum : X JANGAN gunakan garis bawah, tanda hubung, atau karakter non-alfanumerik lainnya
  5. Aturan pernyataan kualitas CA1707 : Pengidentifikasi tidak boleh berisi garis bawah
  6. Menggunakan garis bawah tidak sesuai dengan CLS (untuk pengidentifikasi publik dan terlindungi)
  7. Konvensi penamaan internal pengembang .NET Framework : Jangan gunakan awalan untuk variabel anggota. Jika Anda ingin membedakan antara variabel lokal dan variabel anggota Anda harus menggunakan "ini." dalam C # dan "Me." dalam VB.NET.

Diambil dari file Bantuan Microsoft StyleCop:

TypeName: FieldNamesMustNotBeginWithUnderscore

CheckId: SA1309

Penyebab: Nama bidang dalam C # dimulai dengan garis bawah.

Deskripsi Aturan:

Pelanggaran aturan ini terjadi ketika nama bidang dimulai dengan garis bawah.

Secara default, StyleCop melarang penggunaan garis bawah, m_, dll., Untuk menandai bidang kelas lokal, mendukung 'ini.' awalan. Keuntungan menggunakan 'ini.' adalah bahwa ia berlaku sama untuk semua jenis elemen termasuk metode, properti, dll., dan bukan hanya bidang, membuat semua panggilan ke anggota kelas langsung dikenali, terlepas dari editor mana yang digunakan untuk melihat kode. Keuntungan lain adalah ia menciptakan diferensiasi yang cepat dan dapat dikenali antara anggota instance dan anggota statis, yang tidak akan diawali sebelumnya.

Jika bidang atau nama variabel dimaksudkan untuk cocok dengan nama item yang terkait dengan Win32 atau COM, dan dengan demikian perlu dimulai dengan garis bawah, letakkan bidang atau variabel dalam kelas NativeMethods khusus. Kelas NativeMethods adalah kelas apa pun yang berisi nama yang diakhiri dengan NativeMethods, dan dimaksudkan sebagai pengganti untuk pembungkus Win32 atau COM. StyleCop akan mengabaikan pelanggaran ini jika item ditempatkan dalam kelas NativeMethods.

Deskripsi aturan yang berbeda menunjukkan bahwa praktik yang disukai selain yang di atas adalah memulai bidang pribadi dengan huruf kecil, dan yang umum dengan huruf besar.

Sunting: Sebagai tindak lanjut, halaman proyek StyleCop berada di sini: https://github.com/DotNetAnalyzers/StyleCopAnalyzers . Membaca melalui file bantuan memberi banyak wawasan tentang mengapa mereka menyarankan berbagai aturan gaya.

Karena kita berbicara tentang bidang pribadi, itu tidak memengaruhi pengguna kelas Anda.

Tetapi saya sarankan menggunakan garis bawah untuk bidang pribadi, karena dapat membuat kode lebih mudah dipahami, misalnya:

private int foo;
public void SetFoo(int foo)
{
  // you have to prefix the private field with "this."
  this.foo = foo;

  // imagine there's lots of code here,
  // so you can't see the method signature



  // when reading the following code, you can't be sure what foo is
  // is it a private field, or a method-argument (or a local variable)??
  if (foo == x)
  {
    ..
  }
}

Di tim kami, kami selalu menggunakan awalan garis bawah untuk bidang pribadi. Jadi ketika membaca beberapa kode, saya dapat dengan mudah mengidentifikasi bidang pribadi dan membedakannya dari penduduk setempat dan argumen. Di satu sisi, garis bawah dapat dilihat sebagai versi singkat "ini."

Setelah bekerja di lingkungan yang memiliki aturan gaya yang sangat spesifik dan sangat tidak berarti sejak saat itu saya terus menciptakan gaya saya sendiri. Ini adalah salah satu jenis yang saya bolak-balik pada banyak. Saya akhirnya memutuskan bahwa bidang pribadi akan selalu menjadi _field, variabel lokal tidak akan pernah memiliki _ dan akan menjadi huruf kecil, nama variabel untuk kontrol akan secara longgar mengikuti notasi Hongaria, dan parameter umumnya akan menjadi camelCase.

Saya benci this.kata kunci itu hanya menambahkan terlalu banyak suara kode menurut pendapat saya. Saya suka Resharper menghapus ini berlebihan. kata kunci.

Pembaruan 6 tahun: Saya menganalisis internal Dictionary<TKey,T>untuk penggunaan khusus akses bersamaan dan salah membaca bidang pribadi sebagai variabel lokal. Bidang pribadi seharusnya tidak boleh berupa konvensi penamaan yang sama dengan variabel lokal. Jika ada garis bawah, itu akan sangat jelas.

Saya suka garis bawah, karena saya dapat menggunakan nama huruf kecil sebagai parameter metode seperti ini:

public class Person
{
    string _firstName;

    public MyClass(string firstName)
    {
        _firstName = firstName;
    }

    public string FirstName
    {
        get { return _firstName; }
    }
}

Saya masih sangat suka menggunakan garis bawah di depan bidang pribadi karena alasan yang disebutkan Martin, dan juga karena bidang pribadi kemudian akan diurutkan bersama di IntelliSense. Ini terlepas dari kejahatan notasi awalan Hongaria secara umum.

Namun, belakangan ini saya menemukan bahwa menggunakan awalan garis bawah untuk anggota pribadi tidak disukai, meskipun saya tidak yakin mengapa. Mungkin orang lain tahu? Apakah itu hanya prinsip awalan? Atau apakah ada sesuatu yang terlibat dengan pencabutan nama tipe generik yang mendapat garis bawah di dalamnya dalam kumpulan yang dikompilasi atau sesuatu?

Rekomendasi Gaya Cop atau tidak, menggali ke dalam .NET Framework menunjukkan banyak penggunaan "_" untuk variabel anggota. Apa pun yang direkomendasikan oleh pencipta Style Cop, itu bukan yang digunakan sebagian besar karyawan MS. :) Jadi saya akan tetap dengan garis bawah. Karena saya pribadi membuat kesalahan jauh lebih sedikit menggunakan garis bawah maka ini (contoh: menggunakan varName = varName, bukan this.varName = varName, itu benar-benar terjebak dalam diriku)

Saya pikir pada umumnya bidang tingkat kelas adalah kesalahan dalam desain bahasa. Saya lebih suka jika properti C # memiliki cakupan lokal sendiri:

public int Foo
{
   private int foo;
   get
   {
      return foo;
   }
   set
   {
      foo = value;
   }
}

Itu akan memungkinkan untuk berhenti menggunakan bidang sepenuhnya.

Satu-satunya saat saya awalan bidang pribadi dengan garis bawah adalah ketika properti membutuhkan bidang dukungan yang terpisah. Itu juga satu-satunya saat saya menggunakan bidang pribadi. (Dan karena saya tidak pernah menggunakan bidang yang dilindungi, internal, atau publik, itu satu-satunya saat saya menggunakan periode bidang.) Sejauh yang saya ketahui, jika variabel perlu memiliki ruang lingkup kelas, itu adalah properti dari kelas.

Notasi _fieldName untuk bidang pribadi sangat mudah dipecahkan . Menggunakan "ini." Notasi tidak mungkin dipatahkan. Bagaimana Anda memecahkan notasi _? Mengamati:

private void MyMethod()
{
  int _myInt = 1; 
  return; 
}

Ini dia, saya baru saja melanggar konvensi penamaan Anda tetapi kompilasi. Saya lebih suka memiliki konvensi penamaan yang a) tidak hungaria dan b) eksplisit. Saya mendukung penghapusan penamaan Hongaria dan ini memenuhi syarat. Alih-alih jenis objek di depan nama variabel Anda memiliki tingkat aksesnya.

Bandingkan ini dengan Ruby di mana nama variabel @my_numbermengikat nama ke dalam cakupan dan tidak bisa dipecahkan.

sunting: Jawaban ini sudah negatif. Saya tidak peduli, tetap saja.

Saat Anda ingin agar perakitan Anda sesuai dengan CLS, Anda dapat menggunakan atribut CLSCompliant dalam file assemblyinfo Anda. Compiler kemudian akan mengeluh ketika kode Anda mengandung hal-hal yang tidak sesuai dengan cls.

Kemudian, ketika Anda memiliki 2 properti yang hanya berbeda dalam kasus, kompiler akan mengeluarkan kesalahan. Di sisi lain, ketika Anda memiliki bidang pribadi dan properti publik di kelas yang sama, tidak akan ada masalah.

(Tapi, saya juga selalu awali anggota pribadi saya dengan garis bawah. Ini juga membantu saya untuk memperjelas ketika saya membaca kode saya bahwa variabel tertentu adalah bidang anggota).

Saya suka menggunakan garis bawah di depan bidang pribadi saya karena dua alasan. Satu telah disebutkan, bidang menonjol dari properti terkait dalam kode dan Intellisense. Alasan kedua adalah bahwa saya dapat menggunakan konvensi penamaan yang sama apakah saya sedang mengkode dalam VB atau C #.

Tidak ada implikasi apa pun. Ketika kode Anda dikompilasi, semua yang penting bagi kompiler adalah bidang dan visibilitas bidang / properti. Garis bawah sama pentingnya dengan karakter lain saat menamai pengidentifikasi. Trik sebenarnya adalah menggunakan konvensi yang Anda dan orang-orang di sekitar Anda akan mengerti.