6赞

你如何设定主要和次要评论的风格？

作者：贴进你的心聆听你的世界 | 2023-09-01 14:31

如何解决《你如何设定主要和次要评论的风格？》经验，为你挑选了0个好方法。

有时我想写一个"主要"注释来描述一大块代码,然后编写"次要"注释来描述该代码块中的一些行:

// Major comment

// Minor comment
...

// Minor comment 2
...

主要评论看起来很奇怪,没有代码直接在它下面,你无法直观地告诉它下面描述了多少代码.

你如何设计这些评论？

(我记得很久以前在Code Complete中读到过这个,但我没有这本书.)

推荐阅读

程序员
无论如何在sitecore中自动接受克隆通知吗？

如何解决《无论如何在sitecore中自动接受克隆通知吗？》经验，为你挑选了1个好方法。 ... [详细]
程序员
获取客户端的IP地址

如何解决《获取客户端的IP地址》经验，为你挑选了2个好方法。 ... [详细]
程序员
OperationCanceledException VS任务取消时的TaskCanceledException

如何解决《OperationCanceledExceptionVS任务取消时的TaskCanceledException》经验，为你挑选了1个好方法。 ... [详细]
程序员
从孩子那里得到变数

如何解决《从孩子那里得到变数》经验，为你挑选了1个好方法。 ... [详细]
程序员
为`values_at`方法的选择器使用索引数组

如何解决《为`values_at`方法的选择器使用索引数组》经验，为你挑选了1个好方法。 ... [详细]
程序员
使用步长python列出一个列表项？

如何解决《使用步长python列出一个列表项？》经验，为你挑选了0个好方法。 ... [详细]
程序员
this.value返回包含值的括号

如何解决《this.value返回包含值的括号》经验，为你挑选了1个好方法。 ... [详细]
程序员
调试Spark 1.6.0中的"检测到托管内存泄漏"

如何解决《调试Spark1.6.0中的"检测到托管内存泄漏"》经验，为你挑选了1个好方法。 ... [详细]
程序员
将'$'删除到R中的文本中

如何解决《将'$'删除到R中的文本中》经验，为你挑选了1个好方法。 ... [详细]
程序员
初始化期间无法成功更新网络信息

如何解决《初始化期间无法成功更新网络信息》经验，为你挑选了0个好方法。 ... [详细]
程序员
展平密封的案例类层次结构

如何解决《展平密封的案例类层次结构》经验，为你挑选了0个好方法。 ... [详细]
程序员
pycharm ssh interpter没有这样的文件或目录

如何解决《pycharmsshinterpter没有这样的文件或目录》经验，为你挑选了1个好方法。 ... [详细]
程序员
检查平衡分组字符时在线判断运行时错误

如何解决《检查平衡分组字符时在线判断运行时错误》经验，为你挑选了1个好方法。 ... [详细]
程序员
为什么C++标准为std :: bitset :: reference指定了析构函数？

如何解决《为什么C++标准为std::bitset::reference指定了析构函数？》经验，为你挑选了0个好方法。 ... [详细]
程序员
如何使用JUnit和Hamcrest比较双打？

如何解决《如何使用JUnit和Hamcrest比较双打？》经验，为你挑选了1个好方法。 ... [详细]
程序员
在r中重复一些元素

如何解决《在r中重复一些元素》经验，为你挑选了1个好方法。 ... [详细]
程序员
注释声明中String []的默认值是什么？

如何解决《注释声明中String[]的默认值是什么？》经验，为你挑选了1个好方法。 ... [详细]
程序员
将未知分隔符的.csv加载到Pandas DataFrame中

如何解决《将未知分隔符的.csv加载到PandasDataFrame中》经验，为你挑选了2个好方法。 ... [详细]
程序员
未捕获的ReferenceError:未定义Vue

如何解决《未捕获的ReferenceError:未定义Vue》经验，为你挑选了1个好方法。 ... [详细]
程序员
将数据从SQL导入MongoDB.全有或全无

如何解决《将数据从SQL导入MongoDB.全有或全无》经验，为你挑选了0个好方法。 ... [详细]

贴进你的心聆听你的世界

这个屌丝很懒，什么也没留下！

关注作者

Tags | 热门标签

RankList | 热门文章