فصل اول:‌ خوانا بنویسیم

چگونه بدون دانستن کامل یک استاندارد برنامه‌نویسی خواناتر کد بزنیم؟

این فصل با توجه به اشکالات رایج برنامه‌نویسان تازه کار نوشته شده و با توجه به استاندارد یا کتاب خاصی نمی‌باشد.

هدف این فصل توجه به استاندارد خاصی نیست و به سرعت می‌توانید با رعایت نکات توضیح داده شده کدی تمیز و مرتب بنویسید.

فصل اول شامل قوانین کلی بدون توجه به یک استاندارد خاص می‌باشد, اصولی که برای نوشتن یک کد تمیز لازم است .

قواعد:

۱. استفاده از tab:

به منظور متمایز کردن کدهای درون بلاک از دیگر قسمت‌ها و خوانایی بیشتر استفاده می‌شود, کد‌های هر بلاک با tab از دیگر بلاک‌ها متمایز می‌شود.

بلاک:

بلاک به قسمتی از کد گفته می‌شود که شامل خط یا خطوطی از کدها می‌باشد مانند حلقه‌ها, شرط‌ها , تاوابع, کلاس‌ها و ...

C:

if(condition){
    return true;
}
else{
    return false;
}

Block in Block:

if(condition1){
    if(condition2){
        return true;
    }
    else{
        return false;
    }
}

در بعضی از زبان‌ها استفاده از tab جزو قواعد اصلی زبان است و استفاده نکردن از آن موجب بروز error می‌شود مثل پایتون:

python:

if condition:
    return True
else:
    return False

۲. استفاده از comment:

کد خوب کدی است که آنقدر تمیز و مرتب نوشته شده باشد که نیازی به کامنت نداشته باشد ولی با این حال بهتر است از کامنت استفاده کنیم تا هم کار را برای برنامه‌نویسان احتمالی که ممکن است در آینده روی کد ما کار کنن آسان کنیم و هم اگر در آینده خودمان خواستیم روی کد تغییراتی ایجاد کنیم کار سریع تر پیش رود.

نوشتن توضیحاتی در مورد هدف هر فایل یا کتابخانه, نوع استفاده و هدف ایجاد هر متغیر, تابع و دیگر اجزای کد, نوشتن نام و توضیحاتی در مورد نویسنده کد از جمله کاربرد های کامنت می‌باشد.

کامنت:

کامنت به توضیحاتی گفته می‌شود که در مورد کد یا قسمتی از کد توضیحاتی را بیان می‌کند اما هنگام اجرای برنامه اجرا نمی‌شوند.

برای مطالعه بیشتر روی کامنت‌ها به این لینک مراجعه کنید.

در زبان‌های برنامه‌نویسی از علایم مختلفی برای کامنت گذاری استفاده می‌شود:

• در python از #
• از // برای کامنت کردن یک خط و از /**/ برای کامنت‌کردن بیش از یک خط در زبان‌های java, c#, c++, c, css, ... استفاده می‌شود
• در متلب از %
• ...

python:

ix = 0        # index to scan array
count = 1    # counter of positive values

C:

int ix;        // index to scan array
int count;    // counter of positive values
int positiveCounter(){
    // it counts all positive numbers

}

۳. استفاده از ثوابت:

متغیر‌هایی که در کد مقدار ثابت و پراستفاده‌ای دارند را بصورت ثابت در ابتدای کد تعریف کنید تا در صورتی که نیاز باشد مقدار آن تغییر کند فقط یک بار این کار را انجام داده و لازم نباشد در طول کد بارها این عمل را انجام دهید.

ثوابت معمولا با حروف بزرگ تعریف می‌شوند تا برنامه‌نویسان در هر کجای کد که با این متغییر‌ برخورد کردند بدانند که با یک متغییر از نوع ثابت برخورد کرده‌اند که دارای دسترسی فقط خواندنی (read only) می‌باشد و نمی‌توانند مقدار آنرا تغییر دهند.

برای مطالعه بیشتر در مورد ثوابت به این لینک مراجعه کنید.

C:

#define SPEED 9600
const SPEED = 9600;

python:

SPEED = 9600

def setSpeed(sp):
    while sp < SPEED:
        ...

۴. فضای سفید:

رها کردن بعضی خطوط باعث افزایش خوانایی کد می‌شود.

برای مثال میان بدنه توابع یا بین فراخوانی کتابخانه‌های مورد نیاز برنامه و شروع کدهای برنامه می‌توان با رها کردن یک خط به خوانایی کد کمک کنیم.

C:

#include<stdio.h>

void main(){

    int start = 0;
    int end = 100;

    int i;

    for(i = start; i < end; i++){
        printf("standard code :)");
    }
}

python:

import request

def getLink(api):

    codes = requests.get(api)
    jsonResult = json.loads(codes.content)

    link = jsonResult["images"][0]["url"]

    except:
        print ("net is off")    # it runs if net is off .
    else:
        downLink = baseUrl + link   # make download link .
        print (downLink)

api = "https://www.bing.com/HPImageArchive.aspx?format=js&idx=0&n=1&mkt=en-US"
getLink(api)

۵. گذاشتن فاصله بعد از عملگرها:

استفاده از فاصله قبل و بعد از عملگرها (* + - = /).

In Correct:

sum=sum+i;

Correct:

sum = sum + i;

فقط بعد از جداکنندها(: , ;) از فاصله استفاده کنید.

In Correct:

l = [2,3 , 4]

Correct:

l = [2, 3, 4]

۶. قبل و بعد از پرانتز نیازی به استفاده از فاصله نیست.

python:

def testFunc():
    print("Hello, World!!!")