|
|
|
|
移动端

1.3.3 注释

《C# 6.0本质论(第5版)》第1章C#概述,本章使用传统HelloWorld程序介绍C#,重点是C#语法基础,包括在C#程序中定义入口。通过本章的学习,将熟悉C#的语法风格和结构,并能写最简单的C#程序。本节为大家介绍注释。

作者:周靖/庞燕 译来源:人民邮电出版社|2017-07-21 14:53

【新品产上线啦】51CTO播客,随时随地,碎片化学习

1.3.3 注释

本节将修改代码清单1-16中的程序,在其中添加注释。注释不会改变程序的执行,只是使代码变得更容易理解。代码清单1-18中展示了新的代码,输出1-7展示了对应的输出。

代码清单1-18 在代码中添加注释

输出1-7

  1. Hey you!  
  2. Enter your first name: Inigo  
  3. Enter your last name: Montoya  
  4. Your full name is Inigo Montoya. 

虽然插入了注释,但编译和执行新程序之后生成的输出和以前是一样的。

程序员使用注释来描述和解释他们写的代码,尤其是在语法本身难以理解的时候,或者是在另辟蹊径实现一个算法的时候。只有检查代码的程序员才需要看注释,编译器会忽略注释,因而生成的程序集中看不到源代码中的注释的一丝踪影。

表1-2总结了4种不同的C#注释。代码清单1-18使用了其中的两种。

表1-2 C#注释类型

第9章将更全面地讨论XML注释。届时将讨论XML标准的各种XML标记。

编程史上,确实有一段时期认为,如果一个程序员编写的代码没有详尽的注释,都不好意思说自己是专业和有经验的程序员。但是时代变了。没有注释但可读性好的代码比需要注释才能说清楚的代码更具价值。如果开发人员发现需要写注释才能说清楚代码块的功用,就应该考虑更清楚地重写代码,而不是洋洋洒洒写一堆注释。写注释其实就是重复代码思路的过程。不仅会造成混乱,降低可读性,还很容易过时,因为将来可能更改代码却没有及时更新注释。

规范

不要使用注释,除非代码本身“一言难尽”。

要尽量编写清晰的代码,而不是通过注释澄清复杂的算法。

初学者主题:可扩展标记语言

可扩展标记语言(Extensible Markup Language,XML)是一种简单而又灵活的文本格式,常用于Web应用程序以及应用程序间的数据交换。XML之所以是“可扩展”的,是因为XML文档中包含的是对数据进行描述的信息,也就是所谓的元数据(metadata)。下面是一个示例XML文件:

  1. <?xml version="1.0" encoding="utf-8" ?> 
  2. <body> 
  3.   <book title="Essential C# 6.0"> 
  4.       <chapters> 
  5.           <chapter title="Introducing C#"/> 
  6.           <chapter title="Operators and Control Flow"/> 
  7.           ...  
  8.       </chapters> 
  9.   </book> 
  10. </body> 

文件以 Header元素开始,它描述了XML文件的版本和字符编码方式。之后是“book”元素。元素以尖括号中的单词开头,如< body>。为了结束元素,要将同一个单词放在尖括号中,同时为单词添加一个正斜杠前缀,如< /body>。除了元素,XML还支持属性。 title="Essential C# 6.0"就是XML属性的例子。注意,XML文件包含了对数据(如“Essential C# 6.0”、“Operators and Control Flow”等)进行描述的元数据(书名、章名等)。这可能形成相当臃肿的文件,但优点是提供了描述来帮助解释数据。

喜欢的朋友可以添加我们的微信账号:

51CTO读书频道二维码


51CTO读书频道活动讨论群:342347198

【责任编辑:book TEL:(010)68476606】

回书目   上一节   下一节
点赞 0
分享:
大家都在看
猜你喜欢

读 书 +更多

计算机与网络基础知识——考点解析及模拟训练

本书是根据全国计算机技术与软件专业技术资格(水平)考试的“计算机网络管理员考试大纲”所要求的考试范围而编写的辅导用书。全书共分10章...

订阅51CTO邮刊

点击这里查看样刊

订阅51CTO邮刊