Programming languages 用大写字母评论?

Programming languages 用大写字母评论?,programming-languages,comments,Programming Languages,Comments,我的教授今天告诉我,我应该在所有CAP中对我的代码(PHP和Javascript)进行注释……这是有实质性的原因还是最佳实践的问题 如果是这样的话,为什么用大写而不是句子大小写来评论更好呢?首先,像这样的文体问题可能有点主观,所以不一定有明确的“正确”或“错误”答案。话虽如此,我从未见过在任何专业编写的代码中这样做,也没有见过在任何编码标准中推荐这种做法 考虑以下段落(摘自): 鉴于奥布赖恩对该党的欺骗性和恶意表现出高度的认识(例如,他承认参与了戈尔茨坦神话的创建和推广),他自己在多大程度上真正

我的教授今天告诉我,我应该在所有CAP中对我的代码(PHP和Javascript)进行注释……这是有实质性的原因还是最佳实践的问题


如果是这样的话,为什么用大写而不是句子大小写来评论更好呢?

首先,像这样的文体问题可能有点主观,所以不一定有明确的“正确”或“错误”答案。话虽如此,我从未见过在任何专业编写的代码中这样做,也没有见过在任何编码标准中推荐这种做法

考虑以下段落(摘自):

鉴于奥布赖恩对该党的欺骗性和恶意表现出高度的认识(例如,他承认参与了戈尔茨坦神话的创建和推广),他自己在多大程度上真正相信该制度?为什么他不被认为是思想罪犯?还是说,只要其他所有人都相信,党内党员就不会像外部党员那样真正地遵守党的信仰?还是他在练习某种形式的双重思维

读起来很讨厌,不是吗

以下是“正常”文本中的段落:

鉴于奥布赖恩对该党的欺骗性和恶意表现出高度的认识(例如,他承认参与了戈尔茨坦神话的创建和推广),他自己在多大程度上真正相信该制度?为什么他不被认为是思想罪犯?还是说,只要其他所有人都相信,党内党员就不会像外部党员那样真正地遵守党的信仰?还是他在练习某种形式的双重思维

第二种方法显然更容易阅读。在这种情况下,将评论大写只会使其更难阅读


我能想到的唯一原因是,有人可能会建议这样做,以便于与代码区分,但这并不是一个长期有效的理由(除非您试图在记事本或其他非常糟糕的工具中编写代码)因为现代IDE通过语法突出来解决这个问题。

没有很好的理由这样做,而且,对学术界来说,你的教授不是有点疯狂就是在欺骗你。或者(就像亚当建议的那样)你误解了他的建议。所有大写字母的字形高度不变,使得其可读性不如使用正确的大小写。有没有可能他/她说的是对常数名使用所有大写字母?e、 g.这实际上是一个主观问题,属于@mikeAtlas:我很困惑,请其他人解释一个问题……这难道不值得在这里发布一些东西吗@拉里:这不是一个恶棍……我只是在学习草根风格的代码,所以问题可能会被认为是恶棍式的@亚当,不,他是说在“/”之后写我的评论在现实世界中,用所有大写字母写评论是非常不寻常和不必要的。评论应该容易阅读!然而,你确实需要获得分数,因此,对于你为这位教授所做的作业,请用大写字母进行评论。