Secured Communication

1. Starting Projects
2. Commits Tags
3. Guidelines

1. Starting Projects

In Solution Explorer, select the solution (the top node).
Choose the solution node's context (right-click) menu and then choose Properties.
Expand the Common Properties node, and choose Startup Project.
Choose Multiple Startup Projects.
Move Server Project followed by the Client Project to the top and set their actions to Start.
Click Apply.
Press (CTRL + F5) to start projects without debugging.

2. Commits Tags

Prepend the following tags to your commit messages depending on the project you are modifying.

Tag	Project(s)
`[AES]`	AES
`[VIS]`	AES.Visualizer
`[C/S]`	Client/Server
`[STG]`	Stego
`[CMP]`	Stego.Comparer
`[TST]`	*.Test

3. Guidelines

3.1. Naming Conventions

Identifier	Case	Example
Segments	lowercase	`.data`, `.code`
Instructions	lowercase	`loop`, `pushad`
Registers	lowercase	`eax`, `ah`, `al`
Labels	camelCase*	`forLoop:`
Procedures	PascalCase	`MyProcedure`
Constants	UPPERCASE	`ROUNDS = 10`
Directives	UPPERCASE	`BYTE`, `WORD`, `DWORD` `PROC`, `ENDP`, `INVOKE` `LENGTHOF`, `SIZEOF` `TYPE`, `OFFSET`, `PTR`

* Always less than or equal 10 characters.

3.2. Formatting

3.2.1. Alignment

Always align same identifiers on the same column for better readability.

.data
errorMessage    BYTE    "Invalid Choice!", 0
message         BYTE    "Hello World!", 0
total           WORD    0F10h
sum             DWORD   0

3.2.2. Statements Format

Indent your statements with 3 tabs.
Put your labels on the same line of the instruction in the indentation whitespace.
Align your instruction at the stop of the third tab from column one.
Align your operands at the stop of the second tab from the instructions column.
Separate your operands with a comma followed by a whitespace.
Align your comments all on the same column though out the whole source code.

lbl:[··][··]mov·[··]ecx,·ebx[··][··];·comment for labeled instruction
[··][··][··]mov·[··]ecx,·ebx[··][··];·comment for 3-chars-long instruction
[··][··][··]xchg[··]ecx,·ebx[··][··];·comment for 4-chars-long instruction
[··][··][··]movzx[·]ecx,·ebx[··][··];·comment for 5-chars-long instruction


- ·    = 1 whitespace
- ··   = 2 whitespaces
- [·]  = 3 whitespaces
- [··] = 4 whitespaces (tab)

3.3. Documenting Parametrized Procedures

Use the following template for commenting your procedures.

;-----------------------------------------------------
PromptForIntegers PROC,
    ptrPrompt   :PTR BYTE,  ; prompt string
    ptrArray    :PTR DWORD, ; pointer to array
    arraySize   :DWORD      ; size of the array
;
; Prompts the user for an array of integers and fills
; the array with the user's input.
; Returns: nothing
;-----------------------------------------------------

3.4. Commenting

3.4.1. No Trivial Comments

Don’t explain the actions of an instruction in your code unless that instruction is doing something that isn’t obvious.
Write your comments in such a way that minor changes to the instruction do not require that you change the corresponding comment.

bad:        mov     ax, 0       ; Set AX to zero. (Worse than no comment at all)
good:       mov     ax, 0       ; AX is the resulting sum. Initialize it.*

* Note that the comment does not say "Initialize it to zero." Although there would be nothing intrinsically wrong with saying this, the phrase "Initialize it" remains true no matter what value you assign to ax.

3.4.2. Standalone Comments

Whenever a comment appears on a line by itself, always put the semicolon in column one. You may indent the text if this is appropriate or aesthetic.

; Compute the transpose of a matrix using the algorithm:
;
; for i := 0 to 3 do
;   for j := 0 to 3 do
;       swap( a[i][j], b[j][i] );

            mov      ecx, 3
 forlp1:    mov      ebx, ecx
            mov      ecx, 3
 forlp2:    ...
            loop     forlp2
            loop     forlp1

Adjacent lines of comments should not have any interspersed blank lines. A blank comment line should, at least, contain a semicolon in column one.
```
; This is a comment with a blank line between it and the next comment.
;
; This is another line with a comment on it.
```

MichaelSafwatHanna/secured-communication