Catatanku untuk penulisan kode php

Penulisan kode sumber php harus standard, karena memang sudah ada standard yang mengaturnya. Tujuannya adalah agar kode sumber php tersebut mudah dibaca oleh programmer lain selain programmer yang membuat. Standard penulisan kode tidak hanya ada di dunia PHP namun juga didunia bahasa pemrograman lain, menurutku karena keahlian memrogram adalah hal teknis, dan hal teknis selalu memiliki standard agar bersifat global apalagi kode sumber tersebut merupakan kode sumber terbuka (open source). Selain mudah dibaca oleh programmer lainnya kode sumber kita juga terlihat rapi. Kami akan menyampaikan beberapa standard penulisan kode sumber yang kami ketahui, antara lain:

– Penamaan Class

Contoh yang benar:


class GeneralLedger {
   function __construct(){

   }
}

class General_Ledger{
   function __construct(){

   }
}

Contoh yang salah:

class generalledger {
    function __construct(){

    }
}

– Penamaan Private dan Public Method

Contoh yang benar (Private):

_purchase_order()
{

}

Contoh yang benar (Public):

purchase_order()
{

}

– Penamaan Function

Contoh yang benar:

function get_picture()
function init_camera()

Contoh yang salah:

function initcamera()
function initCamera()
function getpicturejpeg()
function getPictureJpeg()
function get_picture_jpeg_from_camera()

– Penamaan Variable

Contoh yang benar:

for ($j = 0; $j < 10; $j++)
$str
$temporary
$user_id
$last_page

Contoh yang salah:

$j = 'foo';
$Str
$bufferedText
$groupid
$name_of_last_city_used

– Penamaan Konstanta

Contoh yang benar:

MY_CONSTANT
NEWLINE
SOFTWARE_FULL_VERSION

Contoh yang salah:

mYConstant
newline
SOFTWARE_full_version

– Penulisan TRUE, FALSE dan NULL

Contoh yang benar:

if ($payment == TRUE)
$credit = FALSE;
function set_payment($payment = FALSE)

Contoh yang salah:

if ($payment == true)
$credit = false;
function set_payment($payment = false)

 

Itu adalah beberapa standard penulisan kode sumber php yang kami ketahui, semoga bermanfaat disaat kami lupa.

Silahkan Komentar ... !

Isikan data di bawah atau klik salah satu ikon untuk log in:

Logo WordPress.com

You are commenting using your WordPress.com account. Logout / Ubah )

Gambar Twitter

You are commenting using your Twitter account. Logout / Ubah )

Foto Facebook

You are commenting using your Facebook account. Logout / Ubah )

Foto Google+

You are commenting using your Google+ account. Logout / Ubah )

Connecting to %s