Argomenti della funzione di digitazione dinamica: come mantenere elevata la leggibilità?

Penso che molti dei problemi che stai affrontando possano essere risolti con un'appropriata denominazione delle variabili e il contenuto del metodo. Per la maggior parte dovrebbe essere ovvio quali sono i tipi di parametri basati sui nomi e il contenuto del metodo. Anche la documentazione aiuta.

Ad esempio:

function getSum(arr) {
    var sum = 0;
    arr.forEach(arr, function(item) {
        sum += item;
    });

    return sum;
}

Solo dal nome della funzione e da come è scritto dovrebbe essere implicito che getSum prende una serie di numeri e restituisce un numero.

Vediamo un altro esempio che non ha senso irl ma dovrebbe avere un senso a ciò che sta facendo.

var crunchSomeSessionData = function(sessionsMap) {
    var browsers = {};

    Object.keys(sessionsMap).forEach(function(key) {
        var session = sessionsMap[key],
            browser = session.getBrowser();

        if(!browsers[browser]) {
            browsers[browser] = [];
        }

        browsers[browser].push(session.getUserId());
    });

    return browsers;
}

Senza una documentazione adeguata (irl questo sarebbe documentato) puoi ancora vedere che crunchSessionData prende un oggetto di istanze di Session, quelle istanze hanno un metodo getBrowser e getUserId. Restituisce un oggetto disattivato dal browser che ha una matrice di ID utente attualmente presenti su quel browser.

crunchSomeSessionData({
    213j123j123j123j13: {browser: 'chrome', userId: 'pllee'},
    fawefjioawejfwoeiw: {browser: 'ie', userId: 'grandpa'}
})
>> {chrome: ['pllee'], ie: ['grandpa']}

Suggerirei di capire bene come la digitazione dinamica può essere letta, leggere un codice open source che non è molto documentato e vedere se è possibile seguire ciò che sta accadendo. In tal caso, inizia a utilizzare i loro schemi di progettazione. Puoi controllare la semplice libreria di timing delle prestazioni che ho scritto link . È molto piccolo e la maggior parte dei metodi non sono documentati. Il codice non è perfetto ma potrebbe essere un buon esempio. Dopo averlo guardato o usato per mesi, il codice ha ancora senso per me, ma l'ho scritto:)

Forse prova a scriverlo di più in stile OOP. Ad esempio, anziché:

var crunchSomeSessionData = function(sessionsMap, options) {
    [...]
}

perché non puoi farlo

session.crunchData(options)

dove la sessione è l'oggetto che hai creato. Sarai in grado di dare un'occhiata al costruttore per sapere esattamente come viene creata la sessione e tutti i tuoi problemi dovrebbero andare via

Qualsiasi codice dovrebbe essere documentato con informazioni sufficienti per capirlo. Ciò include informazioni sui tipi di variabili, se necessario (e anche nelle lingue tipizzate staticamente, potresti aver bisogno di più informazioni di quelle fornite solo dalla parola chiave type).

Quando ti abitui a lavorare con un linguaggio tipizzato dinamicamente, scoprirai che il tipo di una variabile è spesso autoesplicativo in base al suo utilizzo. Ma se no, aggiungi commenti per chiarirlo.

Per quanto riguarda la tua preoccupazione che tali commenti aggiungano duplicazione (e possibilmente infrangono un principio come DRY), tale preoccupazione si applicherebbe a qualsiasi commento . Qualsiasi documentazione aggiunge intrinsecamente una certa quantità di duplicazione e deve essere mantenuta in modo che corrisponda al codice. Ma quando aiuta a rendere comprensibile il codice, i benefici superano i costi.

Inoltre, si noti che la maggior parte delle altre soluzioni prevede la creazione di tanto (o più) elementi aggiuntivi. Una classe avrebbe bisogno di una definizione di classe che sia grande almeno quanto i commenti. (Naturalmente, fare una lezione potrebbe essere utile per altri motivi, ma non evitare di risolvere ciò con i commenti solo perché aggiungono linee extra al tuo codice.)

I commenti dovrebbero essere fatti solo quando è necessario comprendere il codice, comunque. Odio vedere un codice come questo, che in realtà è una duplicazione inutile:

//crunchSomeSessionData - A function that crunches some session data.
//
//sessionsMap - A map containing the sessions and their data that we want to crunch.
//user - The user for whose sessions we want to crunch data
function crunchSomeSessionData(sessionsMap, user) {
    [...]
}