发现同事们很喜欢写这样的代码注释...

2014-04-03 10:11:35 +08:00
 gangsta
//************* xxx function START *************//

code block...

//************* xxx function END *************//

还有一个是维护类代码的注释,在我待过的公司,以及被外派,出差,各种onsite/offshore合作过的公司中,同样发现很多人都喜欢这么写...

先把bug代码块注释掉,然后...

//************* modified by xxx at 2013-02-14 for xxx reason START *************//

code block...

//************* modified by xxx at 2013-02-14 for xxx reason END *************//
9990 次点击
所在节点    程序员
53 条回复
zoowii
2014-04-03 10:19:39 +08:00
我先注释,跑通没问题的话第二天就删掉
ivenvd
2014-04-03 10:21:36 +08:00
不会用版本管理的同事……
muzuiget
2014-04-03 10:32:50 +08:00
我也很烦这种到处留名的注释,大块无用代码注释,靠,用版本管理的话,什么都清清楚楚了。
lyragosa
2014-04-03 10:36:00 +08:00
我也很喜欢用这种注释
nicai000
2014-04-03 10:49:28 +08:00
xxx blame多好用的
bengol
2014-04-03 10:53:07 +08:00
比用中文注释好多了,各种编码切换~
wvidc
2014-04-03 11:17:14 +08:00
很好啊 方便二次开发 容易上手
wizardoz
2014-04-03 11:28:37 +08:00
还有一种,要在函数注释头中写上调用了哪些函数,以及被哪些函数调用。各种蛋疼。
likai
2014-04-03 11:30:41 +08:00
我怎么觉得不错,别人接手一看明
lu18887
2014-04-03 11:31:59 +08:00
在LINUX 下VI编程,这种注释已经是很友好的了!版本控制工具,在图形化界面下很nice,但是在命令行下就没那么明了了。
lemonlwz
2014-04-03 11:34:37 +08:00
如何一行注释都没有,会否习惯呢?
wlh
2014-04-03 11:59:51 +08:00
我自己的Blog代码都这么写……下次一看就知道,否则经常忘了这块是什么用的要想半天
Pixeller
2014-04-03 12:04:45 +08:00
挺好的, lz你哪天看到一大段一大段被别人改, 如果别人没有注释, 谁知道哪里被框掉了? 小改动看看blame还行, 日积月累, 还能看得过来?
FrankFang128
2014-04-03 12:09:25 +08:00
WebStorm 自动添加 function separator,这个功能还是有点用的
DogonLin
2014-04-03 12:10:59 +08:00
做SAP的时候里面基本都是这种注释。。。。
NetCobra
2014-04-03 12:18:27 +08:00
我不喜欢这种注释,这种活应该是版本管理的功能,不应该用注释来干。
raincious
2014-04-03 12:21:03 +08:00
@lu18887 我一直以为git branch new_branch和git add new_file.c是在命令行下敲的。
bsbgong
2014-04-03 12:40:21 +08:00
1. 这注释很好,我也喜欢这样写的,不过现在的team guidelines里不许这样写了。看各团队自己的规范,大家一致遵守就好。
2. 程序注释就没必要吐槽了。个人趣味不同,你觉得不好用的别人觉得好用。
wdlth
2014-04-03 12:45:54 +08:00
我一般用DOC型注释
/**
* 描述
*
* @author 作者
* @version 版本
* @package
*
*/
这类的
wklken
2014-04-03 13:05:27 +08:00
刚毕业那会在的公司很喜欢用,因为代码管理混乱,特别是一些不得不改的公用部分
声明的目的是界定说这块代码是xxx加的,没事别乱改,要改去找当事人

不过好久没见到了......

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/107065

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX