|
|
4. Delphi扩展类类型:MyStrings = TStrings.Create;
1.5 注释
Delphi支持两种注释:块注释({})和单行注释(//)。注释的作用是为了解释程序的设计思路,帮助程序员尽快明白两年前甚至昨天写的程序的思路。这实际上是为了解决记忆问题,大脑不该被过分作为存储器使用,在程序设计中永远不要过分依赖大脑,而要尽可能借助文字。所以说,注释在程序设计语言中是十分重要的方面,尽管很多人(尤其是初学者,也包括相当数量的程序员)对此毫不介意,他们很少写注释。注释的另外一个应用是在程序调试阶段,比如说有两个语句,事先并不知道哪一个更好,于是需要测试:将一条语句前放置"//"(也就是说将这条语句改为注释),运行另一条语句,然后再做相反的工作,我们就可以轻松做出选择。如果是一组语句,那就用块注释,但一定注意要将"{"和"}"放在显眼的位置,比如说放在单独的上下两行。下面是一些使用原则:
1. 多数情况下,在自定义变量、类型的前面放置注释是有必要的。
2. 多数情况下,在单元文件顶部放置注释是必要的。在此,注释中要包含:文件名、创建日期、修改日期、作者、修改作者以及必要的描述。
3. 注释要有意义,不要使用没用的注释。比如:
while i < 8 do
begin
…
i:= i + 1; //Add one to i
end;
注释“//Add one to i”在此是毫无意义的,当然并不是说简单的语句(类似于:i : = i + 1)就不需要注释。因为简单的语句往往会起到十分重要的作用,所以,如果这条语句会使人产生疑问或者让人难以理解,那么就要将此语句的作用标记下来。
4. 不要试图在注释中创建组合图案,除非你认为这十分必要。因为在保持图案完整美观的情况下修改注释是非常困难的。。
5. 要区分临时注释和永久注释,你可以用你的方法在注释中放置特殊符号来区分。这样的好处是易于查找。
6. 对语句的更改要映射到相应的注释中。
7. 注释与代码间要留有明显的间隔,要一眼就能够分清楚哪是语句哪是注释。可以将注释放在代码行的前一行、后一行或留有至少两个空格紧跟在代码的后面,但是在代码与注释在同一行时不要使代码跟在注释的后面,另外,不要将在注释放在代码中间。
2. 语句
2.1 begin…end语句
begin和end语句要独占一行,begin要与上一层的第一个字母对齐,也就是说在换行之后不要留任何空格而直接写begin,end要与所对应的begin对齐。本规则可以用在任何地方。下面是正确的写法:
for i:= 1 to 10 do
上一页 [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] 下一页
网友评论:(评论内容只代表网友观点,与本站立场无关!) |
阅读排行
|