Termiologie correcte pour la documentation

Question

La documentation ci-dessous est pour un module qui a maintenant été "désarmé" et j'écris maintenant son remplacement. Avant que j'écrive le remplacement je veux obtenir mes termes corrects. Je sais que les termes sont faux dans la documentation - il a été piraté ensemble rapidement afin que je puisse instruire un collège travaillant sur le côté matériel de ce projet sur la façon d'utiliser un programme que j'ai fait. Le documentaire complet peut être trouvé here pour tous ceux qui sont intéressés (dans la mesure où il a été écrit et ajouté à notre wiki), le site peut être disponible pour certains IPS (dépend de vous ISP - les connexions internet des universités sont plus susceptibles de fonctionner), et le dépôt SVN est privé.

Il y a donc beaucoup de termes qui sont faux. tels que.
deliminators
chaîne formatée contenant des expressions de valeur (peut maintenant être tort, mais est difficile à dire)

Quelles sont les conditions correctes pour ces derniers. Et ce que d'autres erreurs que j'ai fait

 


    ==== formatted string containing value expressions ==== 
    Before I start on actual programs an explanation of: 
    "formatted string containing value expressions" and how to encode values in them. 

    The ''formatted string containing value expressions'' is at the core of doing low level transmission. 
    We know the decimal 65, hex 41, binary 0100 0001, and the ascii character 'A' all have the same binary representation, so to tell which we are using we have a series of deliminators - numbers preceded by: 
    # are decimal 
    $ are Hex 
    @ are binary 
    No deliminator, then ascii. 

    Putting a sign indicator after the deliminator is optional. It is required if you want to send a negative number. 

    You may put muliple values in the same string. 
    eg: "a#21@1001111$-0F" 

    All values in a ''formatted string containing value expressions'' must be in the range -128 to 255 (inclusive) as they must fit in 8bytes (other values will cause an error). Negative numbers have the compliment of 2 representation for their binary form. 

    There are some problems with ascii - characters that can't be sent (in future versions this will be fixed by giving ascii a delineator and some more code to make that deliminator work, I think). 
    Characters that can't be sent: 
    * The delineator characters: $#@ 
    * Numbers written immediately after a value that could have contained those digits: 
     * 0,1,2,3,4,5,6,7,8,9 for decimal 
     * 0,1,2,3,4,5,6,7,8,9,a,b,c,d,e,f,A,B,C,D,E,F for hex 
     * 0,1 for binary 

Answer 1

Pour commencer, deliminator serait probablement-je delimiter, bien que l'avis de votre texte est à la fois délinéateur et deliminator en elle - peut-être deliminator est un séparateur/combinaison de terminaison spéciale :-) Cependant, un délimiteur est généralement utilisé pour séparer les champs et est généralement présent quoi qu'il arrive. Ce que vous avez est un préfixe facultatif qui dicte le type de champ suivant. Donc j'appellerais probablement cela un préfixe ou un préfixe de type à la place. La "chaîne formatée contenant des expressions de valeur" J'appellerais simplement une "chaîne d'expression de valeur" ou une "chaîne de valeur" pour la remplacer par une forme plus courte.

Un autre problème possible:

doit être comprise entre -128 et 255 (inclus) car ils doivent tenir dans

8 octets

Je pense que vous voulez dire 8 morceaux.

Answer 2

Essayez quelque chose comme ce qui suit:

 
    ==== Value string encoding ==== 
    The value string is at the core of the data used for low level 
    transmissions. 

    Within the value string the following refixes are used: 
    # decimal 
    $ Hex 
    @ binary 
    No prefix - ASCII. 

    An optional sign may be included after the delimiter for negative numbers. 
    Negative numbers are represented using twos complement. 

    The value string may contain multiple values: 
    eg: "a#21@1001111$-0F" 

    All elements of the value string must represent an 8bit value and must 
    be in the range -128 to 255 

    When using ASCII representation the following characters that can't be sent 
    * The delineator characters: $#@ (use prefixed hex value.) 
    * Numbers written immediately after a value that could have 
     contained those digits: 
     * 0,1,2,3,4,5,6,7,8,9 for decimal 
     * 0,1,2,3,4,5,6,7,8,9,a,b,c,d,e,f,A,B,C,D,E,F for hex 
     * 0,1 for binary 

chaîne d'expression de valeur