Comment, whitespace আর মানুষের পড়ার মতো code

Amara আর Kenji একই tile হিসাবের program জমা দিল। দুইটাই warning ছাড়া compile হয়। দুইটাই ঠিক উত্তর ছাপে।

Amara-রটা পড়তে দশ সেকেন্ড লাগে। Kenji-রটা পড়তে দশ মিনিট, আর সে ওটা লিখেছে গতকাল। এই lesson program কী করে সেটা বদলায় না; পুরোটাই বদলায় পরের মানুষটার বুঝতে কত সময় লাগবে সেটা।

Compiler তোমার জীবনের একমাত্র পাঠক, যে তোমার style নিয়ে কখনো নালিশ করে না। বাকি প্রতিটা পাঠক করে, আর তাদের একজন হলো ছয় মাস পরের তুমি।

দুই রকম comment, আর কোনটা কোথায় খাটে

Comment হলো মানুষের জন্য একটা টুকে রাখা কথা। Compiler তোমার code দেখার আগেই preprocessor প্রতিটা comment মুছে দেয়, তাই একটা comment কখনো program-র কাজ বদলাতে পারে না।

C তোমাকে দুইটা রূপ দেয়।

// চলে লাইনের শেষ পর্যন্ত। এটা এসেছে C99-এ, আর একটা লাইনের পাশে বা কয়েকটা লাইনের উপরে ছোট একটা কথা লিখতে তুমি এটাই চাও।

/* ... */ যত লাইন চাও তত লাইন জুড়ে থাকতে পারে, আর শেষ হয় কেবল তুমি বন্ধ করলে। একটা file বা একটা function-র মাথায় একটা অনুচ্ছেদ লিখতে এটা ব্যবহার করো।

দ্বিতীয় রূপটার সঙ্গে দুইটা নিয়ম আসে। এর ভেতরে এটা বসে না, তাই প্রথম */-ই ওটা বন্ধ করে দেয়। আর */ একেবারে ভুলে গেলে GCC বলে error: unterminated comment, আর তোমার /*-র পরের সবটা চুপচাপ comment হয়ে গেছে।

তাই // এক বাক্যের জন্য, /* */ এক অনুচ্ছেদের জন্য, আর বন্ধ না করা একটা /* গোটা একটা function গিলে ফেলতে পারে।

Comment বলে কেন, কী করছে সেটা না

কাজের comment আর বাজে comment-র তফাত এই একটা নিয়মেই। Code নিজেই বলে দিচ্ছে সে কী করছে। Comment তার জায়গাটা অর্জন করে এমন কিছু বলে, যেটা code বলতে পারে না।

বাজে, আর শুরুতে সবাই এটাই লেখে:

total = total + marks;   /* add marks to total */

কাজের, কারণ এটা একটা সিদ্ধান্ত বোঝাচ্ছে:

total = total + marks;   /* the retake mark replaces nothing, it stacks */

চার রকম comment প্রায় সব সময়ই লেখার মতো। কেন এই পথ, আর সোজা পথটা কেন না। একটা সংখ্যা কোথা থেকে এল। একটা লাইন তার input নিয়ে কী ধরে নিচ্ছে। আর পরের মানুষটাকে কোনো ফাঁদ নিয়ে সতর্ক করা।

এক রকম comment সব সময়ই মুছে দেওয়ার মতো: যেটা তার পাশের লাইনটাই আবার বলে। ওটা পড়ার কাজ দ্বিগুণ করে, আর লাইনটা বদলানোর মুহূর্তেই বাসি হয়ে যায়।

তাই একটা comment যদি code ঢাকা রেখে পড়লেও টিকে যায়, তাহলে ওটা সম্ভবত কাজের কিছু বলছে।

নাম: সবচেয়ে সস্তা documentation

নাম হলো এমন একটা comment, যেটা compiler তোমার হয়ে মিলিয়ে দেখে, কারণ ভুল নামটাও সব জায়গায় একই বানানে থাকে।

C নামে অক্ষর, অঙ্ক আর underscore চলতে দেয়, আর নাম অঙ্ক দিয়ে শুরু হতে পারে না। ফলে style বাছার সুযোগ তোমার থাকে, আর এই track ব্যবহার করে snake_case: ছোট হাতের অক্ষর, শব্দের মাঝে underscore, যেমন total_marks আর boxes_needed।

একটা নামের তিনটা পরীক্ষা:

• অচেনা কেউ কি আন্দাজ করতে পারবে ওতে কী আছে? total_score পারবে, ts পারবে না।
• এটা কি একক বা ধরনটা বলে? delay_seconds delay-কে হারায়, আর is_valid হারায় flag-কে।
• এটা কি সৎ? area নামের একটা variable যদি পরিসীমা ধরে রাখে, সেটা x নামেরটার চেয়েও খারাপ, কারণ ওটা পাঠককে মিথ্যা বলছে।

ছোট আয়ুর জিনিসের ছোট নামই ঠিক। i নামের একটা loop counter একটা রেওয়াজ, ব্যর্থতা না, কারণ ওটা বাঁচে তিন লাইন। যে variable পঞ্চাশ লাইন বাঁচে, সে পঞ্চাশটা character-র ভাবনা পাওয়ার যোগ্য।

তাই ভালো একটা নাম comment-র দরকারটাই মিটিয়ে দেয়, আর খারাপ নামকে comment দিয়ে বাঁচানো যায় না।

Indentation আর brace: এই track যে একটাই style মানে

Compiler তোমার সাজানো একেবারেই গোনে না। নিচের প্রতিটা লাইন তার কাছে একই program, আর এর একটামাত্র রূপ তুমি উত্তরাধিকারে পেতে চাইবে।

এই track একটাই style মানে, একবার বলে দেওয়া, যাতে তোমার পড়া প্রতিটা example একই ভাবে সাজানো থাকে:

• প্রতি স্তরে চারটা space, কখনো tab না, আর দুইটা মিলিয়ে তো নাই।
• Function-র শুরুর brace নিজের লাইনে, আর শেষের brace প্রথম ঘরে।
• প্রতি লাইনে একটা statement। এক লাইনে দুইটা statement কিছুই বাঁচায় না, একটাকে লুকিয়ে ফেলে।
• সম্পর্কিত লাইনের দলগুলোর মাঝে একটা ফাঁকা লাইন, বইয়ে অনুচ্ছেদ যেভাবে কাজ করে।
• প্রতিটা binary operator-র দুই পাশে একটা space: a * b, a*b না।

অন্য project অন্যভাবে বাছে, আর তারা ভুল না। Linux kernel আট চওড়া tab ব্যবহার করে আর brace একই লাইনে রাখে। আসল কথা হলো, একটা file, আর আদর্শভাবে একটা project, একটা বেছে নিয়ে আর কখনো তর্ক করে না।

তাই কোন style নেবে সেটা একবারের সিদ্ধান্ত, আর সব সময় ভুল একটাই জিনিস: এক file-এ দুইটা style।

Compiler যে whitespace গোনে না, পাঠক গোনে

Whitespace মানে space, tab আর ফাঁকা লাইন। Token-র মাঝে C যত whitespace-ই থাকুক একটা বিভাজক ধরে নেয়, তাই int a = 5; আর int a=5; compiler-র কাছে অবিকল এক।

দুই জায়গায় এটা বিনা পয়সার না। Keyword বা নাম ভাঙা যায় না, তাই in t a; একটা error। আর একটা string literal-র ভেতরে প্রতিটা space সত্যিকারের একটা character, যেটা ছাপা হয়।

কাজের ফলটা এই: একটা লম্বা statement-কে কয়েক লাইনে ছড়িয়ে তার টুকরোগুলো সাজিয়ে রাখতে পারো। Compiler-র কিছুই মনে হবে না।

তাই সাজানোটা পাঠকের জন্য, আর ঠিক দুইটা জায়গায় compiler তাকিয়ে আছে।

এই track নিয়ে একটা সৎ কথা

এই track-র প্রতিটা program প্রকাশের আগে compile করে চালানো হয়েছে, আর output-র ঘরগুলো সত্যিকারের output, অনুমান না। যে tool এটা করে তার নাম verify-code.mjs, আর সে দুই ভাষার প্রতিটা code block compile করে।

এখানকার কোনো program তোমার কাছে গোলমাল করলে আগে টাইপের ভুল খোঁজো, তারপর আমাদের জানাও। ছাপা বইটাও এই একই কথা দেয়। সেজন্যই একটা output-র ঘরকে তুমি এতটা বিশ্বাস করতে পারো যে নিজেরটা তার সঙ্গে মিলিয়ে দেখো।

// A single-line comment. Runs to the end of this line.

/* A block comment.
   It can span as many lines as you like,
   and it ends only when you close it. */

int marks = 90;   // a comment may sit after code too

#include <stdio.h>
int main(void){int l=5;int w=3;int a=l*w;printf("Order %d boxes\n",a);return 0;}

Order 15 boxes

#include <stdio.h>

int main(void)
{
    int room_length = 5;
    int room_width = 3;

    int boxes_needed = room_length * room_width;

    printf("Order %d boxes\n", boxes_needed);
    return 0;
}

Order 15 boxes

#include <stdio.h>

int main(void)
{
    /* Room measurements in metres, from the site survey of 12 March.
       Both are whole numbers because the supplier only cuts to the metre. */
    int room_length = 5;
    int room_width = 3;

    /* Tiles ship in boxes of one square metre, so the area is the box count. */
    int boxes_needed = room_length * room_width;

    printf("Order %d boxes\n", boxes_needed);   // the shop wants boxes, not area
    return 0;
}

Order 15 boxes

i = i + 1;   /* add one to i */

/* fix this later
    printf("Order %d boxes\n", boxes_needed);
    return 0;
}

/* Boxes of half a square metre each. */
int boxes_needed = room_length * room_width;

int main(void)
{
    int a = 1;
	int b = 2;
        int c = 3;
}

#include <stdio.h>

int main(void)
{
    /* Marks out of 50, doubled to give a percentage. */
    int physics = 37;
    int chemistry = 41;

    /* Average of the two subjects. */
    int total = physics + chemistry;

    printf("%d\n", total * 2);
    return 0;
}

#include <stdio.h>
int main(void){int p=37;int c=41;int t=p+c;printf("Total %d\n",t);printf("Subjects 2\n");return 0;}

#include <stdio.h>

int main(void)
{
    int reading = 512;
    int calibrated = reading - 12;
    int percent = calibrated / 5;

    printf("Tank at %d percent\n", percent);
    return 0;
}

পরের lesson-এ তুমি নিজে একটা program compile করে চালাবে, Playground-এ, আর চাইলে নিজের মেশিনে gcc দিয়ে।