java代码注释中的5要与3不要是什么

这篇文章主要介绍“java代码注释中的5要与3不要是什么”，在日常操作中，相信很多人在java代码注释中的5要与3不要是什么问题上存在疑惑，小编查阅了各式资料，整理出简单好用的操作方法，希望对大家解答”java代码注释中的5要与3不要是什么”的疑惑有所帮助！接下来，请跟着小编一起来学习吧！

创新互联公司专注于凌河企业网站建设,响应式网站建设,成都做商城网站。凌河网站建设公司,为凌河等地区提供建站服务。全流程按需策划，专业设计，全程项目跟踪，创新互联公司专业和态度为您提供的服务

代码注释，可以说是比代码本身更重要。这里有一些方法可以确保你写在代码中的注释是友好的：

java代码注释中的5要与3不要是什么

不要重复阅读者已经知道的内容

能明确说明代码是做什么的注释对我们是没有帮助的。

// If the color is red, turn it green
if (color.is_red()) {
  color.turn_green();
}

要注释说明推理和历史

如果代码中的业务逻辑以后可能需要更新或更改，那就应该留下注释:)

/* The API currently returns an array of items
even though that will change in an upcoming ticket.
Therefore, be sure to change the loop style here so that
we properly iterate over an object */

var api_result = {items: ["one", "two"]},
    items = api_result.items,
    num_items = items.length;

for(var x = 0; x < num_items; x++) {
  ...
}

同一行的注释不要写得很长

没什么比拖动水平滚动条来阅读注释更令开发人员发指的了。事实上，大多数开发人员都会选择忽略这类注释，因为读起来真的很不方便。

function Person(name) {
  this.name = name;
  this.first_name = name.split(" ")[0]; // This is just a shot in the dark here. If we can extract the first name, let's do it
}

要把长注释放在逻辑上面，短注释放在后面

注释如果不超过120个字符那可以放在代码旁边。否则，就应该直接把注释放到语句上面。

if (person.age < 21) {
  person.can_drink = false; // 21 drinking age

  /* Fees are given to those under 25, but only in
     some states. */
  person.has_car_rental_fee = function(state) {
    if (state === "MI") {
      return true;
    }
  };
}

不要为了注释而添加不必要的注释

画蛇添足的注释会造成混乱。也许在学校里老师教你要给所有语句添加注释，这会帮助开发人员更好地理解。但这是错的。谁要这么说，那你就立马上给他个两大耳刮子。代码应该保持干净简洁，这是毋庸置疑的。如果你的代码需要逐行解释说明，那么你最需要做的是重构。

if (person.age >= 21) {
  person.can_drink = true; // A person can drink at 21
  person.can_smoke = true; // A person can smoke at 18
  person.can_wed = true; // A person can get married at 18
  person.can_see_all_movies = true; // A person can see all movies at 17
  //I hate babies and children and all things pure because I comment too much
}

注释要拼写正确

不要为代码注释中的拼写错误找借口。IDE可以为你检查拼写。如果没有这个功能，那就去下载插件，自己动手！

要多多练习

熟能生巧。试着写一些有用的注释，可以问问其他开发人员你的注释是否有用。随着时间的推移，你会慢慢懂得怎样才算是友好的注释。

要审查别人的注释

在代码审查时，我们往往会忽略查看注释。不要怕要求更多的注释，你应该提出质疑。如果每个人都养成写好注释的好习惯，那么世界将会更美好。

到此，关于“java代码注释中的5要与3不要是什么”的学习就结束了，希望能够解决大家的疑惑。理论与实践的搭配能更好的帮助大家学习，快去试试吧！若想继续学习更多相关知识，请继续关注创新互联网站，小编会继续努力为大家带来更多实用的文章！

文章名称：java代码注释中的5要与3不要是什么
网站地址：https://www.cdcxhl.com/article36/pdippg.html

成都网站建设公司_创新互联，为您提供域名注册、ChatGPT、品牌网站制作、软件开发、搜索引擎优化、响应式网站