14赞

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

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

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

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

// Major comment

// Minor comment
...

// Minor comment 2
...

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

你如何设计这些评论？

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

推荐阅读

程序员
使用继承重叠Spring bean名称

如何解决《使用继承重叠Springbean名称》经验，为你挑选了1个好方法。 ... [详细]
程序员
如何强制Axis客户端使用TLSv1.2协议

如何解决《如何强制Axis客户端使用TLSv1.2协议》经验，为你挑选了1个好方法。 ... [详细]
程序员
使用ggplot2的直方图中心条

如何解决《使用ggplot2的直方图中心条》经验，为你挑选了1个好方法。 ... [详细]
程序员
IncomingMessage中止事件

如何解决《IncomingMessage中止事件》经验，为你挑选了0个好方法。 ... [详细]
程序员
Openlayers 3 Offset RegularShape

如何解决《Openlayers3OffsetRegularShape》经验，为你挑选了0个好方法。 ... [详细]
程序员
如何重现相同状态的基于随机的算法

如何解决《如何重现相同状态的基于随机的算法》经验，为你挑选了1个好方法。 ... [详细]
程序员
phpMyAdmin提供export.php而不是数据库sql转储

如何解决《phpMyAdmin提供export.php而不是数据库sql转储》经验，为你挑选了1个好方法。 ... [详细]
程序员
MySQL:通过块检索大的选择

如何解决《MySQL:通过块检索大的选择》经验，为你挑选了1个好方法。 ... [详细]
程序员
从对象创建Jackson对象节点

如何解决《从对象创建Jackson对象节点》经验，为你挑选了1个好方法。 ... [详细]
程序员
React Native Pause/Play GIF

如何解决《ReactNativePause/PlayGIF》经验，为你挑选了0个好方法。 ... [详细]
程序员
react-native - 包含View的Fit Image,而不是整个屏幕大小

如何解决《react-native-包含View的FitImage,而不是整个屏幕大小》经验，为你挑选了3个好方法。 ... [详细]
程序员
R - 使用正则表达式从字符串中提取数字

如何解决《R-使用正则表达式从字符串中提取数字》经验，为你挑选了1个好方法。 ... [详细]
程序员
在导航抽屉中添加图标

如何解决《在导航抽屉中添加图标》经验，为你挑选了0个好方法。 ... [详细]
程序员
`std :: make_tuple`的原因是什么？

如何解决《`std::make_tuple`的原因是什么？》经验，为你挑选了2个好方法。 ... [详细]
程序员
我弄乱了JSON对象,数组和字符串

如何解决《我弄乱了JSON对象,数组和字符串》经验，为你挑选了1个好方法。 ... [详细]
程序员
使用FFMPEG以最小的重新编码添加覆盖

如何解决《使用FFMPEG以最小的重新编码添加覆盖》经验，为你挑选了0个好方法。 ... [详细]
程序员
如何以允许传递临时值的方式将std :: istream传递给函数？

如何解决《如何以允许传递临时值的方式将std::istream传递给函数？》经验，为你挑选了1个好方法。 ... [详细]
程序员
Azure Powershell:Login-AzureRmAccount的相反命令是什么(以前是Clear-AzureProfile)

如何解决《AzurePowershell:Login-AzureRmAccount的相反命令是什么(以前是Clear-AzureProfile)》经验，为你挑选了1个好方法。 ... [详细]
程序员
在Symfony 3.0中给出"string","Vendor\NameBundle\Form\EntitynameType"类型的预期参数

如何解决《在Symfony3.0中给出"string","Vendor\NameBundle\Form\EntitynameType"类型的预期参数》经验，为你挑选了1个好方法。 ... [详细]
程序员
如何在没有循环的情况下将list转换为字符串,在Python中将join()转换为

如何解决《如何在没有循环的情况下将list转换为字符串,在Python中将join()转换为》经验，为你挑选了1个好方法。 ... [详细]

贴进你的心聆听你的世界

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

关注作者

Tags | 热门标签

RankList | 热门文章