软件工程师手册/语言词典/示例模板
外观
<描述语言,如果可能,包括简要历史。>
<描述这是否是一种脚本语言、小型语言、完整语言:过程式或函数式。>
<描述程序如何/在哪里启动,例如 C++ 的 main()>
<尝试对典型代码行的内容进行高级描述。赋值示例可能适用,例如
a = b;
>
<描述并展示注释的语法,例如
// this is an inline comment. Everything after the // is a comment.
块注释由起始 /* 和结束 */ 指定,它们可以跨越多行。
/* * this is a block comment */
>
<描述是否需要变量声明,并给出不同类型变量的示例,例如
将 i 声明为整数
int i;
两种方法将 i 声明为整数并赋予其初始值为 0
int i = 0; int i(0);
>
<描述方法/函数/过程是如何声明和实现的。>
<描述作用域是如何定义的。>
<用文字描述条件语句,并给出
code examples.
(在行首添加一个空格以格式化为代码)>
<用英文描述循环语句并给出代码示例。>
<描述如何输出“Hello world!”,包括换行符,使用或不使用回车符。>
<描述错误处理和恢复。根据需要给出示例。>
<列出此语言原生提供的容器或容器列表的参考。列出如果容器不是语言原生提供的,那么如何整合容器。>
<列出此语言原生提供的算法或算法列表的参考。列出如果算法不是语言原生提供的,那么如何整合算法。或者,如果不可用,则描述。>
<描述垃圾收集是自动的还是手动的。>
<描述文件、库和部分通常是如何划分和排列的。>
<请包含便于从另一种语言切换到这种语言的提示。>
<列出网络上的其他参考资料。请包括参考资料适合什么级别的读者。(初学者/中级/高级)>
<列出可能有所帮助的其他书籍和文章。请包括参考资料适用于什么级别的读者。(初级/中级/高级)>