چطور مثل یک حرفه‌ای برنامه بنویسیم – بخش اول: انتخاب نام برای متغیرها

چندی پیش شخص از من خواست تا به کدی که نوشته بود نگاهی بیندازم. این کد را در انتهای این پست آورده‌ام. این کد یک مساله‌ی دشوار را حل می‌کند. مطمئن هستم که بیشتر از ۹۰ درصد از برنامه‌نویس‌ها و دانشجویان رشته‌ی کامپیوتر قادر به حل کردن این مساله نیستند (اگر فکر می‌کنید که جز این ۹۰ درصد نیستید امتحان کنید). من قصد ندارم که در این مورد که این کد چقدر خوب یا بد این مساله را حل می‌کند نظری بدهم. فقط می‌خواهم چند سطر در مورد این موضوع که چطور می‌توان این کد را بهتر کرد توضیح بدهم.

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

برای این‌که پیچیدگی برنامه‌ها کم‌تر شود باید کاری کرد که افرادی که کد را می‌خوانند (چه به قصد فهمیدن، چه به قصد رفع اشکال، چه به قصد بهبود دادن) به سادگی بتوانند بفهند که هر متغیر به چه منظور تعریف شده و چه مقداری در أن ذخیره می‌شود.

در یکی از سطرهای این برنامه این دستور را می‌توانید پیدا کنید:

k = 3;

برای اینکه بفهمید این دستور چه کاری انجام می‌دهد باید بدانید که متغیر k برای چه منظوری تعریف شده است. برای اینکه بفهمید k برای چه منظوری تعریف شده است باید سطری که متغیر k در آن تعریف شده را پیدا کنید و اگر خوش‌شانس باشید در کنار آن توضیح داده شده است که k برای چه تعریف شده است. اگر خوش‌شانس نباشید باید فردی که این کد را نوشته پیدا کنید و از او بپرسید که چرا k را تعریف کرده است. باز هم اگر آدم خوش‌شانسی باشید خودتان کد را نوشته‌اید و با کمی فکر کردن یادتان می‌آید که چرا k را تعریف کرده‌اید. در غیر این صورت باید از پشت دستگاه بلند شوید و دنبال فردی که کد را نوشته بگردید . اگر در این حالت هم خوش‌شانس باشید فرد در دست‌رس است و می‌توانید از او سوال بپرسید. نمی‌خواهم بیش‌تر از این بحث را با توضیح دادن سناریوهای مختلف طولانی کنم. ولی در یک جمله در تمام این سناریوها لازم است که شما چند لحظه تمرکز خود را از روی مساله‌ی اصلی بردارید و به یک موضوع فرعی (متغیر k) فکر کنید. لازم نسیت یادآوری کنم که مساله‌ی اصلی به اندازه‌ی کافی پیچیده است و به تمرکز زیادی نیاز دارد (هیچ کس دوست ندارد هنگاه راه رفتن یک تخم مرغ را به وسیله‌ی یک قاشق در دهانش حمل کند).

این دو دستور را با هم مقایسه کنید:

k = 3;

و

subStringLength = 3;

یا حتی اگر به جز زبان مادری خود زبان دیگری نمی‌دانید

touleZirReshte = 3;

وقتی یک نفر دستور اول را می‌خواند هیچ برداشتی به او دست نمی‌دهد. ولی وقتی دستور دوم (یا سوم) را می‌خواند خیلی راحت حدس می‌زند که این دستور طول زیررشته را برابر با ۳ قرار می‌دهد. دقت کنید که در همین پاراگراف هم برای اینکه ببینید دستور اول و دوم و سوم چه بودند باید تمرکز خود را از روی پاراگراف برمی‌داشتید و چند بار به پاراگراف‌های بالاتر مراجعه می‌کردید.

متاسفانه در این کدِ این برنامه این نوع متغیرها کم نیستند. i , j , m , temp, sub. دلیل این امر شاید به فرهنگ نادرستی بر‌می‌گردد که توسط کتاب‌های آموزش برنامه‌نویسی ترویج داده می‌شود. بسیاری از کتاب‌های آموزش برنامه‌نویسی نام‌های این‌چنینی برای متغیرها انتخاب می‌کنند. بخشی از أن هم به فرهنگی بر می‌گردد که در بین ریاضی‌دان‌ها استفاده می‌شود. ریاضی‌دان‌ها معمولا از نمادهای تک حرفی برای بیان روابط و معادله‌ها استفاده می‌کنند. اما کد یک برنامه‌ی کامپیوتری با اثبات یک قضیه ریاضی خیلی تفاوت دارد و نباید از فرهنگ رایج ریاضی‌دان‌ها برای نوشتن برنامه‌های کامپیوتری استفاده کرد (مگر أن‌که به ساده‌تر شدن مساله کمک کند).

همین موضوع در مورد نام تابع‌هایی که در برنامه تعریف شده‌اند نیز صدق می‌کند. تقریبا تمام تابع‌های تعریف شده در این برنامه نام‌های عجیبی دارند که به هیچ وجه کاری که انجام می‌دهند را القا نمی‌کنند. برای مثال دستور زیر را درنظر بگیرید:

query(input, k);

به نظر شما این دستور چه کاری انجام می‌دهد؟ آیا k بار برای پیدا کردن input جست و جو انجام می‌دهد؟ آیا در کاراکتر kام input جست و جو انجام می‌دهد؟ آیا …

برای پیدا کردن جواب باید حتما به جایی که متغیرهای k و input و تابع query تعریف شده است مراجعه کنید و توضیحات مربوط به أن‌ها را بخوانید (اگر خوش‌شانس باشید). حالا دستور زیر را در نظر بگیرید.

splitIntoSubstrings(inputString, substringLength);

به سادگی می‌توان فهمید که این دستور رشته‌ی inputString را به زیر رشته‌هایی با طول substringLength تقسیم می‌کند.

همین موضوع در مورد سایر تابع‌ها به خصوص تابع compute صدق می‌کند. برای مثال دستور زیر را در نظر بگیرید.

compute(str.substring(m).concat(str.substring(0, len - (strLen - m))));

در مورد این‌که این دستور بیش‌تر به یک فاجعه شباهت دارد تا یک دستور که توسط یک برنامه‌نویس خوب نوشته می‌شود خیلی حرف دارم و احتمالا یک پست مجزا در مورد آن خواهم نوشت. ولی در حال حاضر فقط این موضوع را یادآوری می‌کنم که یکی از بدترین اسم‌هایی که برای یک تابع می‌توان انتخاب کرد همین compute است. برخی دیگر از این اسامی عبارتند از process, analyze, calculate, do, perform, init, initilize, start. این نام‌ها به این دلیل نامناسب هستند که هیچ اطلاعاتی در مورد اینکه این تابع‌ها چه کاری انجام می‌دهند به فردی که کد را می‌خواند منتقل نمی‌کنند. همه می‌دانند که هر تابعی بلاخره یک چیزی را حساب (compute) می‌کند، مهم این است که بدانند این تابع چه چیزی را حساب می‌کند.

---

کد اصلی

/* this class implements the encoding requested in problem #1706
*/
/**
* @author Esmaeil Ashrafi <s.ashrafi@gmail.com>
*/
import java.util.ArrayList;
public class StierlitzCipher {
private static String input; // the string suppose to be ciphered
private static int k; // the length of sub strings
// temporary variable for query substrings
private static StringBuffer temp = new StringBuffer();
// an array to store substrings of each query string
private static ArrayList<String> sub = new ArrayList<String>();
/**
* @param args
* the command line arguments
*/
public static void main(final String[] args) {
/*
* if ran in command line console,first argument willl be the string to
* cipher and second considered as the key
*/
if (args.length == 2) {
input = new String(args[1]);
k = Integer.parseInt(args[0]);
} // otherwise use of default values of problem
else {
input = new String("abaccc");
k = 3;
// prompt the user to using default values
System.out.println("doing encrypt by default values:"
+ "\nString : \"abaccc\"\nKey : 3");
}
query(input, k);
System.out.println(); // just for trimming the output !
}// end of main
/**
* gets the entire string and splits it to substrings in length of "len" and
* sends each substring to method compute for calculating the number of
* different non-empty substrings could obtained from them.there will be
* substrings(and consequent call to compute method)call as much as the length
* of parameter str
*
* @param str
* - the string to be cipher
* @param len
* - the length of substrings(the key)
*/
private static void query(final String str, final int len) {
int m;
final int strLen = str.length();
for (m = 0; m <= strLen - len; m++) {
compute(str.substring(m, m + len));
}
for (m = m; m < strLen; m++) {
compute(str.substring(m).concat(str.substring(0, len - (strLen - m))));
}
}// end of query
/**
* queries queryString to calculate number of its different and non-empty
* substrings and prints the count to the standard output
*
* @param queryStr
* - the string to be queried
*/
private static void compute(final String queryStr) {
final int qLen = queryStr.length();
for (int i = 0; i < qLen; i++) {
for (int j = i + 1; j <= qLen; j++) {
if (!sub.contains(temp.replace(0, temp.length(),
queryStr.substring(i, j)).toString())) {
sub.add(temp.toString());
}
}
}
System.out.print(" " + sub.size());
sub.clear();
}// end of compute
}// end of class