Conventions de nommage et commentaires

[azertyfun]

Il faudrait rajouter des conventions de nommages pour les fonctions, les variables et les fichiers parce que là en fonction du codeur ça donne des trucs radicalement différents. Pour les routines il faudrait faire ça :

:maRoutine
    SET B, 1
    SET B, 2
    :maRoutine_sousRoutine
        ADD B, 1
        MUl B, 5
        :maRoutine_sousRoutine_loop
            ADD B, 1
            IFN B, 100
            SET PC, maRoutine_sousRoutine_loop
    SET PC, POP

C'est beaucoup plus clair pour s'y retrouver dans les routines et sous-routines, parce que sinon on ne sait pas quoi appartient à qui ^^

Ensuite, et c'est une convention universelle, un nom de variable commence par une minuscule. Pareil pour un fichier, parce que aux dernières nouvelles on ne fait pas de POO :p Faire une routine "Sched_AddProc" c'est pas du tout correct, ça devrait être "sched_addProc", qui est plus lisible et plus simple à taper ! ^^

Voilàvoilà

Ensuite faudrait vraiment penser à commenter le code, surtout que certains noms de variables de sont pas très explicites. Le scheduler est totalement incompréhensible par exemple. Le registre A est utilisé tout du long mais sans commentaire on doit passer 2 min à se demander à quoi il peut bien correspondre à un endroit précis de la routine.

[Yamakaky]

C'est marrant, tu met en place toutes les idées que j'avais eu avant la Grande Léthargie XD

Petit point de détail : on met les instructions en majuscule ou pas ? Comparaison :

:maRoutine
    SET B, 1
    SET B, 2
    :maRoutine_sousRoutine
        ADD B, 1
        MUl B, 5
        :maRoutine_sousRoutine_loop
            ADD B, 1
            IFN B, 100
            SET PC, maRoutine_sousRoutine_loop
    SET PC, POP

:maRoutine
    set B, 1
    set B, 2
    :maRoutine_sousRoutine
        add B, 1
        mul B, 5
        :maRoutine_sousRoutine_loop
            add B, 1
            ifn B, 100
                    set PC, maRoutine_sousRoutine_loop
    set PC, POP

[azertyfun]

Perso je les met en majuscules mais si c'est en minuscules c'est pas trop grave. De toute façon avant une release c'est tout à fait possible de faire un script à la con qui met tout en majuscules.

[Yamakaky]

oui, pas faux. Y a même des hooks git pour ça ! J'y pense à l'instant, c'est tout à fait possible d'avoir un hook qui convertit tout en maj/min, comme pour la gestion de CRLF/LF. Je me lance ?

[azertyfun]

Mhmm gaffe quand même, ça risque de modifier PUSH_regs et autres conneries du genre, on fera ça une bonne fois avant de faire une release je crois.

[Yamakaky]

Autant utiliser les outils à notre disposition ^^ Perso je sais pas trop, je trouve les min un peu plus lisible

Vaut mieux pas, ça ferai plein de commis pour rien

[azertyfun]

Si je le met en majuscules c'est surtout par habitude ^^ Tant que c'est pas SeT, xOR ou Bor tout va bien :p

[Yamakaky]

C'est surtout pour une homogénéité du code. Je propose la norme suivante :

• les instructions en minuscule
• les registres + POP/PUSH en majuscule
• les labels en minuscule type maRoutine_sousRoutine_loop, pour les distinguer des registres
• un espace après la virgule

Exemple :

set A, B
add label, 5   ; oui, je sais, ça compile pas ^^
add PUSH, POP ; équivalent à mul [SP], 2, sauf erreur ?

[azertyfun]

Ca me semble bien :p

[Yamakaky]

Ok, je vais update le README.

[L3nn0x]

Moi je laisse pas d'espace et push/pop sont en minuscules. On peut pas faire comme ça plutôt ?

[azertyfun]

Ben non parce que c'est moche et pas lisible, espèce de feignant xD Au pire tu fait ctrl+f tu pourras remplacer push par PUSH à la fin :p

[L3nn0x]

mais c'est long de taper un espace en plus après la virgule...

[azertyfun]

Euh... WAT Et puis même ça marche aussi le chercher/remplacer xD

[Yamakaky]

C'est bien ce que je pensait : c'est un fleimard ^^

[L3nn0x]

Bon, bon, je me ferai un script, voilà. Content ?

[azertyfun]

Wi xD

[Yamakaky]

Regarde du côté des git hooks, comme ça il sera lancé automatiquement à chaque commit.

[L3nn0x]

Ok.