你写什么样的代码注释呢?

问题描述

据统计,每个程序开发人员的工作时间中,只有不到一半的时间是花在写代码上,其它的时间一部分是在阅读别人或者自己以前写的代码,另一部分则是花在代码的导航定位上。就拿使用eclipse的开发人员来说,你可能只有一部分的时间是集中在编辑器中写代码,而很多时间你会花在其它的像PackageExplorer,OpenType,等视图上。Eclipse的OpenType和Search等功能可以方便我们很快的查找和定位到相应的代码,但这些都是基于代码的查找和定位,开发人员有时更需要根据自己对代码的标记来查找和定位。Eclise的tasks和bookmarks的视图提供了对代码标记的功能.Eclipse的task机制提供了以注释的形式在代码里面描述任务的功能,在用ECLISPE开发JAVA的时候,你可以在注释中插入一些预先定义好的任务的标记,像“TODO”,“FIXME”,“XXX”,“HACK”等。利用这些,你可以实现比常规注释更丰富的功能.通过做下面这个测试,你可以看下你平常注释的特点和你没考虑到的注释的功能.

解决方案

解决方案二:
还可以 不错啊
解决方案三:
顶!
解决方案四:
曾经有人对我说,写得好的代码就是最好的注释!其实,在开发中,为了方便以后他人的维护还是需要有良好的注释习惯的!如果没有好的注释习惯,常常会发现,自己曾经写的代码,一段时间后,再拿来读,自己都读不懂了!
解决方案五:
我写中文注释
解决方案六:
有道理,顶我们这里也要求的
解决方案七:
只在有可能导致理解困难的地方写注释。至于TODO/FIXME这些标签应该不算注释吧,备个忘而已,这个倒经常用。要求严格的企业,80%的代码注释是没有意义的。通过函数名称、参数名称、清楚的流程可能很大程序上产生注释的效果。
解决方案八:
要通过大脑想的代码,写注释...
解决方案九:
我一般用C代码来注释汇编代码
解决方案十:
个人认为,首要在于程序的逻辑结构,代码排版次之,注释再次之。。。

时间: 2024-10-29 15:06:47

你写什么样的代码注释呢?的相关文章

那些年我们写过的代码注释,没被打死真是奇迹!

曾经年少轻狂,写了三两行简简单单的逻辑代码,却总要在前头署上自己的大名,然后等到生产版本宕机那天,已经换了三四家的公司的你还是被无情夺命连环 Call . 曾经对面坐着的是个花一般的测试,然后代码的注释里,总是会多出好几排空格. 曾经,我们在写代码时,还会有心情写注释. 曾经,写注释时,身边还有你. 望能博君一笑. (部分灵感来源于互联网) //2006-10-05 鬼晓得我下面写的是什么鬼 //2013-03-08 谁能告诉我哪里能找到鬼 /* * TODO 在下一个版本优化这里 * TODO

uclinux-2008R1-RC8(bf561)到VDSP5的移植(2):代码注释

因为uclinux内核是个庞然大物,为避免一开始就遭受打击,所以就决定先将所有的代码注释掉.但是与此同时要保留各个文件之间的依赖关系,因此必须保留#include这样的语句.再考虑到uclinux是通过宏定义来控制各种功能实现的,且宏定义几乎不会对移植造成任何困扰,所以也保留了#if #define这样的语句. 以下就是自己写的一小段代码,用于实现上述功能,在VS2005下可以使用. // hprocess.cpp : 定义控制台应用程序的入口点.//#include "stdafx.h&quo

notepad++编辑html代码代码注释不变颜色了

问题描述 notepad++编辑html代码代码注释不变颜色了 notepad++编辑html代码代码注释不变颜色了,以前会变成绿色的.. 解决方案 是不是文件名的后缀名写错了, 解决方案二: 没写错唉,试了很多次了,昨天还好好的 解决方案三: 看看是不是配色出问题了

编程必知:八个最没有意义的代码注释

多年来,我非常荣幸能和一些谦逊的公司和客户合作.我也因此有机会接触到各种不同的程序员-- 每个程序员都有自己独特的风格.事实上,每个项目本身都有一些独特的元素. 这些特质的交叉让我去思考我曾经审查.更新或提高过的程序代码.与其说是代码的实际逻辑,还不如说是开发人员自己添加到代码中的注释,对代码产生了颇为深远的影响.这篇文章的主题就是罗列一些我印象深刻的一些代码注释. 因为Carol让我这么做 我记得审查程序代码时,有一条注释是这样写的: // Because Carol Told Me to D

《ActionScript 3.0基础教程》——2.3 代码注释

2.3 代码注释 注释是你开发过程中非常重要的部分,它可以帮助你或者你的队友了解代码的含义.注释包括注意.提示.代码解释等.这样其他人就能了解代码的意思了. 就算你是独自一人工作,注释也能在你停止某项目一段时间后又想要返回项目时帮助你理解曾经写下的代码,很多程序员会在工作时写很复杂的代码,当时会记得很清楚,但是在几个月之后他们发现这些代码的意思他们自己已经忘记了. 2.3.1 创建注释在Flash中你有两种创建注释的方法.第一种是一行的注释.这样的注释用"//"创建,任何在双斜杠后面的

GhostDoc Pro v4.9.14093.Cracked.By.SubMain 一款好用的代码注释生成工具——VS插件

原文:GhostDoc Pro v4.9.14093.Cracked.By.SubMain 一款好用的代码注释生成工具--VS插件 一款比较好用的 VS 插件,能够快速生成注释. 这是 Pro 版本,与标准版本相比,支持对类.文件批量生成注释并且可以生成 CHM 帮助文件. 具体差异请转到: http://submain.com/products/ghostdoc.aspx   简化你的XML注释! GhostDoc是一个Visual Studio扩展,自动生成基于其类型,参数,名称和其他上下文

可以少写1000行代码的正则表达式_正则表达式

熟练地掌握正则表达式的话,能够使你的开发效率得到极大的提升. 正则表达式经常被用于字段或任意字符串的校验,如下面这段校验基本日期格式的JavaScript代码: var reg = /^(\\d{1,4})(-|\\/)(\\d{1,2})\\2(\\d{1,2})$/; var r = fieldValue.match(reg); if(r==null)alert('Date format error!'); 下面是在前端开发中经常使用到的20个正则表达式: 1 . 校验密码强度密码的强度必须

Java代码注释规范详解_java

代码附有注释对程序开发者来说非常重要,随着技术的发展,在项目开发过程中,必须要求程序员写好代码注释,这样有利于代码后续的编写和使用. 基本的要求: 1.注释形式统一 在整个应用程序中,使用具有一致的标点和结构的样式来构造注释.如果在其它项目中发现它们的注释规范与这份文档不同,按照这份规范写代码,不要试图在既成的规范系统中引入新的规范. 2.注释内容准确简洁 内容要简单.明了.含义准确,防止注释的多义性,错误的注释不但无益反而有害. 3.基本注释(必须加) (a) 类(接口)的注释 (b) 构造函

程序员都应该学写“规范”的代码

在过去的7年半时间里,我带过的软件实习生超过一打,也看到过数以百计的学生和毕业生的档案.我发现很多事情他们都需要学习.或许你会说,我说的不 就是某种特定的技术.算法.数学,或者其他特定形式的知识吗?没错,这的确是需要学习的,但却并不是最重要的事情.他们需要学习的最重要的东西是"自我规 范".这些规范就是:尽可能地写出最简洁的代码:如果代码后期会因为改动而变得凌乱不堪就得重构:尽量删除没用的代码,并添加注释. 我花了很多时间来敦促这些实习生去学习这些内容.我经常会问他们,怎么样才能成为一