我有一个同事,他坚持认为他的代码不需要注释,这是“自文档”。我已经审阅了他的代码,虽然它比我看到的其他人编写的代码更清晰,但我仍然不同意自文档化代码与经过注释和文档化的代码一样完整和有用。帮我理解一下
我有一个同事,他坚持认为他的代码不需要注释,这是“自文档”。我已经审阅了他的代码,虽然它比我看到的其他人编写的代码更清晰,但我仍然不同意自文档化代码与经过注释和文档化的代码一样完整和有用。帮我理解一下
我的团队开始使用doxygen记录我们的C代码,特别注意我们的公共API头文件。在doxygen中似乎有很大的灵活性和不同的特殊命令,这很好,但不经过反复试验就不清楚什么是好东西,什么是坏东西。你最喜
在Objective C中,我可以使用#pragma mark来标记符号导航器中的代码片段。由于这是一个C预处理器命令,所以在Swift中不可用。在Swift中有替代品吗,或者我必须使用丑陋的评论吗?
我见过Python中编写文档字符串的几种不同风格,最流行的风格是什么?
如何做多行注释?大多数语言都有块注释符号,比如: