🗄️ ♓️ 👩🏾‍🤝‍👩🏻 अच्छे कोड का मुख्य सिद्धांत 🐏 😋 🉑

विविध प्रोग्रामिंग के बीस वर्षों के लिए, मैंने तैयार किया है, मैं आश्वस्त हूं, अच्छे कोड का मुख्य सिद्धांत। इसके आधार पर, मेरे सहयोगियों और मैंने सबसे खराब कोड को साफ करने में असमर्थ, असंगत प्रोग्रामर की एक टीम में एकजुट किया और बहुत अधिक चमक के बिना वर्षों तक सिस्टम बनाए रखा।

इस लेख को पढ़ें: 15 मिनट
तकनीक की समझ: 10 मिनट
मूर्त परिणाम: 30 मिनट

इस प्रकार,

क्यों?

बुरे कोड के बारे में क्या?

कुछ भी स्पष्ट नहीं है
अस्पष्ट चर
विशाल विधियाँ
गैर-स्पष्ट एल्गोरिदम
खाकी एनकैप्सुलेशन उल्लंघन
उच्च जटिलता और जटिलता
परिवर्तनों से आश्चर्य होता है
कुछ भी स्पष्ट नहीं है

कोई आश्चर्य नहीं कि मैंने एक ही पल में दो बार इशारा किया। वास्तव में, लगभग सब कुछ इस तथ्य से नीचे आता है कि प्रोग्रामर कुछ कोड का पता नहीं लगा सकता है।

मैं चीखता हुआ उठता हूं

खराब कोड धीरे-धीरे सही हो जाता है, और परिवर्तन आश्चर्य लाता है। यह समझने योग्य है: प्रोग्रामर यह नहीं देखता है कि कोड क्या कर रहा है, और उसे कुछ नया बनाने के बजाय इसका पता लगाना होगा। दरअसल, अक्सर ऐसा होता है कि केवल लेखक ही कार्यक्रम को ठीक करने में सक्षम होता है।

इसलिए, अच्छे कोड के सबसे महत्वपूर्ण संकेतों में से एक इसकी समझ है। स्पष्टता एक विशुद्ध मानवीय अवधारणा है। संकलक को यह ध्यान नहीं है कि इसे क्या कहा गया है; यह सार में नहीं आता है। केवल एक व्यक्ति कोड पढ़ता है। केवल एक व्यक्ति विधि के नाम से कल्पना कर सकता है कि विधि क्या करती है। केवल एक व्यक्ति एक चर का नाम पढ़ता है और तुरंत उसमें संग्रहीत डेटा का सार देखता है।

मुझे विश्वास है कि कोड की समझदारी नामों पर अधिक निर्भर है। वर्गों, विधियों, चर के नामों से। अधिक स्पष्ट रूप से नाम तैयार किए जाते हैं, और जितने अधिक होते हैं, उतनी ही आसानी से कोड पढ़ा जाता है।

उदाहरण के लिए, मोबाइल डिवाइस पर सूचना भेजने के लिए एक ऐसा कोड होता है:

function locator($device) {
    // Can we locate the device?
    if ($device->token != "" && $device->expire <= $now) {
        return false;
    }

    $modelNotifier = new ModelNotifier($device); 
    return $modelNotifier->go();
}

, - . .

$device?
$device->expire $now? ?
$modelNotifier->go()?

. , , $device->expire , . ModelNotifier->go() , . , , token . , .

, : token!="", . , , .

, . — . , ; , . , .

.

?

, — .

, , , . , — — .

:

function locator($device) {
    // Can we locate the device?
    if ($device->token != "" && $device->expire <= $now) {
        return false;
    }

    $modelNotifier = new ModelNotifier($device); 
    return $modelNotifier->go();
}

, , : “ ?”

:

function ModelDevice::isLocatable() {
    return ($this->token != "" && $this->expire <= $now);
}

…

function locateAndNotifyDevice(ModelDevice $device) {
    if (!$device->isLocatable()) {
        return false;
    }

    $modelNotifier = new ModelNotifier($device);
    return $modelNotifier->go();
}

, , - , .

. isLocatable(). : , :

: , .

:

function isDeviceExpired() {
    return ($this->expireAtUnixtime >= $now);
}

function isOurTokenValid() {
    return ($this->token != "");
}

function isLocatable() {
    return ($this->isOurTokenValid() && !$this->isDeviceExpired());
}

. : isLocatable() , . isDeviceExpired(), , .

— .

, , , token . , : .

, : . Instant win!

?

, . ! , .

-, . , , . , : . , , . . , ? :)

-, - (“ ?”) (“ ?”) . isLocatable(), : , . — , . “” locateDevice(), ; , , . — , .

-, , CPU, . , — 1/3 ^*. , , . , . , , . , .

^*300ms — .

function getConfig() {
    if ($this->hasOption('configs')) {
        $configs = $this->getOption('configs');
    } else if ($this->hasOption('config')) {
        $configs = [ $this->getOption('config') ];
    }

    if (isset($configs)) {
        $root = $this->getOption('root', null);
        if (!$root) {
            if (isset($_SERVER['PWD'])) {
                $root = $_SERVER['PWD'];
            } else if (isset($_SERVER['DOCUMENT_ROOT'])) {
                $root = $_SERVER['DOCUMENT_ROOT'];
            }
        }

        $configs->root = $root;
    }

    return $configs;
}

: ( ), . :

function grabConfiguration() {
    if ($this->hasOption('configs')) {
        return $this->getOption('configs');
    } else if ($this->hasOption('config')) {
        return [ $this->getOption('config') ];
    }
}

function figureOutRootFolder() {
    $root = $this->getOption('root', null);
    if (!$root) {
        $root = $_SERVER['PWD'];
    }
    if (!$root) {
        $root = $_SERVER['DOCUMENT_ROOT'];
    }
    return $root;
}

function getConfigs() {
    $configs = $this->grabConfiguration();  
    if (!is_null($configs)) {
        $configs->rootFolder = $this->figureOutRootFolder();        
    }
    return $configs;
}

iOS:

if ([imageEntry objectForKey:@"fullscreenUrl"]==nil) {
    NSString *kind = [imageEntry objectForKey:@"kind"];
    if ([kind isEqualToString:@"pdf"]) {
        UIImage *i = [UIImage imageNamed:@"galleryPdfIcon"];
        [self.uiImagesCache setObject:i forKey:@(photoIndex)];
        *photoSize = NIPhotoScrollViewPhotoSizeOriginal;
        return i;
    } else if ([kind isEqualToString:@"video"]) {
        UIImage *i = [UIImage imageNamed:@"galleryVideoIcon"];
        [self.uiImagesCache setObject:i forKey:@(photoIndex)];
        *photoSize = NIPhotoScrollViewPhotoSizeOriginal;
        return i;
    } else {
        UIImage *i = [UIImage imageNamed:@"galleryBrokenImage"];
        [self.uiImagesCache setObject:i forKey:@(photoIndex)];
        *photoSize = NIPhotoScrollViewPhotoSizeOriginal;
        return i;
    }
}

, . . :

- (UIImage *) genericImageForKind:(NSString *) imageKind {
    UIImage *candidate = nil;

    if ([kind isEqualToString:@"pdf"]) {
        candidate = [UIImage imageNamed:@"galleryPdfIcon"];
    } else if ([kind isEqualToString:@"video"]) {
        candidate = [UIImage imageNamed:@"galleryVideoIcon"];
    } else {
        candidate = [UIImage imageNamed:@"galleryBrokenImage"];
    }

    return candidate;
}

…

if ([imageEntry objectForKey:@"fullscreenUrl"]==nil) {
    NSString *kind = [imageEntry objectForKey:@"kind"];
    UIImage *genericImage = [self genericImageForKind:kind];
    if (genericImage) {
        [self.uiImagesCache setObject:genericImage forKey:@(photoIndex)];
        *photoSize = NIPhotoScrollViewPhotoSizeOriginal;
    } 

    return nil;
}

SQL . , , , , .

function(err, dResults) {
    if (err) {
        console.log(err);
        callback(err);
        return;
    }

    var i=0, lastDownloaded = null;
    var unixtimes = Object.keys(dResults);
    for(i=0;i<unixtimes.length;i++) {
        if (dResults[unixtimes[i]].isDownloaded) { 
            lastDownloaded = unixtimes[i];
        }
    }

    for(i=0;i<unixtimes.length;i++) {
        if (unixtimes[i]>lastDownloaded) {
            delete dResults[unixtimes[i]];
        }
    }

    self.getOpenPrice(symbol, function(err, openPrice) {
        callback(err, dResults, openPrice);
    });
}

function getLastDownloadedUnixtime(entries) {
    var lastDownloadedUnixtime = null;

    var unixtimes = Object.keys(entries);
    unixtimes.forEach(function(unixtime) {
        if (entries[unixtime].isDownloaded) { 
            lastDownloadedUnixtime = unixtime;
        }
    });

    return lastDownloadedUnixtime;
}

function cleanupEntriesNewerThanLastDownloadedUnixtime(entries, lastDownloadedUnixtime) {
    var unixtimes = Object.keys(entries);
    for(var i=0;i<unixtimes.length;i++) {
        if (unixtimes[i]>lastDownloadedUnixtime) {
            delete entries[unixtimes[i]];
        }
    }
}

…

function(err, dResults) {
    if (err) {
        console.log(err);
        callback(err);
        return;
    }

    var lastDownloadedUnixtime = getLastDownloadedUnixtime(dResults);
    cleanupEntriesNewerThanLastDownloadedUnixtime(dResults, lastDownloadedUnixtime);

    self.getOpenPrice(symbol, function(err, openPrice) {
        callback(err, dResults, openPrice);
    });
}

XML Amazon S3. , , XML :

strcat(xml, "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n");
strcat(xml, "<Delete>\n");
strcat(xml, "<Quiet>true</Quiet>\n");

for (uint32_t i=0;i<batchCount;i++) {
    char *escapedPath=Deleter::xmlEscape(batch[i]);
    strcat(xml, "\t<Object><Key>");
    strcat(xml, escapedPath);
    free(escapedPath);
    strcat(xml, "</Key></Object>\n");
    LOG(LOG_DBG, "[Delete] %s", batch[i]);
}

strcat(xml, "</Delete>\n");

, :

void addPathToDeleteXml(char *xml, char *path) {
    char *escapedPath=Deleter::xmlEscape(path);
    strcat(xml, "\t<Object><Key>");
    strcat(xml, escapedPath);
    strcat(xml, "</Key></Object>\n");
    free(escapedPath);
}

void addBatchOfPathsToXml(char *xml, char **batch, uint32_t batchCount) {
    for (uint32_t i=0;i<batchCount;i++) {
        addPathToDeleteXml(xml, batch[i]);
        LOG(LOG_DBG, "[Delete] %s", batch[i]);
    }
}

…

strcat(xml, "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n");
strcat(xml, "<Delete>\n");
strcat(xml, "<Quiet>true</Quiet>\n");

addBatchOfPathsToXml(xml, batch, batchCount);

strcat(xml, "</Delete>\n");

, — . : , - . , - , - , , .

, . , . , , , .

. , . , . , .

— . , : , , .

. — , - .

. , , , autocomplete.

Update: «if (true) return true» , .. , .

अच्छे कोड का मुख्य सिद्धांत

क्यों?

?

?

More articles: