首页 > 代码库 > 程序风格和文档

程序风格和文档

适当的注释和注释风格

包含在程序的开头,总结和解释这个程序的作用、程序的关键特点和其他所应用的独特技术。

在一个长程序中,还需要包含一些介绍主要步骤和难以读懂部分的注释。

让注释保持简洁非常重要,这样才不会让程序臃肿或难以读懂。

 

正确的缩进和间距

缩进是用来说明程序的组成部分或语句之间的结构关系。恰当对齐的代码更容易让人阅读和维护。

每个子组成部分或语句要比嵌套它的结构多空两格。

二元操作符的两端都应该增加一个空格。

 

 

程序风格和文档