Pentingnya Membuat Comment/Komentar Pada Sintak Editor VB/VB.NET

Saya akan berbagi sedikit tips dalam menulis sintak/coding khususnya vidual basic, hal ini mungkin/biasanya dianggap sepele/kecil tapi sebenarnya sangat berdampak besar yaitu : Comment (komentar) pada editor yang diawali dengan tanda petik 1 ('). Dengan comment ini kita dapat menulis sesuatu dan sesuka hati kita baik itu berupa keterangan tambahan mengenai sintak/logika/variable/date edit,created by dan sebagainya. Misalnya :

'Form Name      : hitung_transaksi

'Function       : Untuk menginput transaksi retur penjualan

'Created by     : djie 2012-09-01

'Last Edited By : pandji 2012-09-05

Public Class Form_Transaksi

  'variable untuk hitung bilangan

        Dim n1 As Integer = 0

        Dim n2 As Integer = 1

     Private Sub Button1_Click(ByValsender As System.Object, ByVal e As  System.EventArgs) Handles Button1.Click

        'jika kode a maka update qty barang

        ' a adalah barang yang di retur

        If kode = "a" Then

            '...sintak update anda

        Else

            'jika kode <> a maka insert barang baru

            '...sintak insert anda

      End Sub

End Class

Hal ini sangat penting karena misalkan program vb nya sudah selesai dan sudah lama/jarang dibuka lagi (misal 1 bulan/6 bulan/1 tahun), lalu anda ingin mengedit atau menambahkan menu/form/komponen/report baru dan sebagainya, maka jika tanpa adanya Comment anda akan bingung dan meraba raba kembali untuk apa variable ini/itu? bagaimana logikanya? parameternya apa? untuk apa fungsinya dan sebagainya, walaupun dulu anda sendiri yang membuat sintak tersebut (pengalaman sendiri). Selain itu Comment seperti contoh diatas sangat baik dan berguna saat anda membuat project bersama sama (misalnya di kantor/software house) agar mudah difahami oleh orang lain jika anda misalnya sakit/tidak masuk kerja dan bahkan jika anda berhenti bekerja sehingga orang baru (pengganti) akan lebih mudah melajutkan sintak anda karena adanaya Comment yang anda buat.

Tags:
cara membuat comment di vb, fungsi dari comment / komentar pada code editor, tutorial vbnet, cara terstruktur membuat sintak, panduan membuat sintak vbnet