Software Engineers Handbook/Language Dictionary/Sample Template

<Language Name Here>

edit

<Describe the language, include a brief history if possible.>

Type

edit

<Describe if this is a scripting, mini language, full language: procedural or functional.>

Execution Entry Point

edit

<Describe how/where the program is started i.e. C++ main()>

General Syntax

edit

<Try to give a high level description of the contents of a typical line of code. An assignment example may be appropriate such as

a = b;

>

Comments

edit

<Describe and show the syntax for comments such as

// this is an inline comment.  Everything after the // is a comment.

Block comments are specified by a starting /* and ending */ They can span multiple lines.

/*
 * this is a block comment 
 */

>

Variable Declarations

edit

<Describe if variable declarations are necessary, and give examples of the different types, such as

declare i as an integer

int i;

two ways to declare i as an integer and give it an initial value of 0

int i = 0;
int i(0);

>

Method Declaration/Implementation

edit

<Describe how methods/functions/procedures are declared and implemented.>

Scope

edit

<Describe how scope is defined.>

Conditional Statements

edit

<Describe the conditional statements in text and present

code examples. 

(put a space in the front of the line to format as code)>

Looping Statements

edit

<Describe looping statements in English and present code examples.>

Output Statements

edit

<Describe how to output Hello world! including the new-line with or without a carriage return.>

Error Handling/Recovery

edit

<Describe error handling and recovery. Give examples as appropriate.>

Containers

edit

<List containers or references to lists of containers available natively for this language. List ways to incorporate containers if they are not native to the language.>

Algorithms

edit

<List algorithms or references to lists of algorithms available natively for this language. List ways to incorporate algorithms if they are not native to the language. Or, if not available, describe that.>

Garbage collection

edit

<Describe whether the garbage collection is automatic or manual.>

Physical Structure

edit

<Describe how the files, libararies, and parts are typically divided and arranged.>

Tips

edit

<Please include tips that make it easier to switch to this language from another language.>

Web References

edit

<List additional references on the web. Please include for what level reader the references are appropriate. (beginner/intermediate/advanced)>

Books and Articles

edit

<List additional books and articles that may be helpful. Please include for what level reader the references are appropriate. (beginner/intermediate/advanced)>