标签: commenting

我对R很新,我一直在脚本文件中定义一些自己的函数.我打算让其他人以后重新使用它们,我找不到任何关于R函数注释约定的指南.我有什么方法可以help("my_function_name")帮助我吗？如果没有,我是否只记录脚本文件中的函数,以便有人打印出(或打开源代码)脚本来查看注释？

谢谢,

Hamy

我正在完成一个我已经工作了一段时间的项目,而且我正在进行最后的修改.

我想做的一件事是在每个类文件的顶部添加类描述(以帮助我自己和其他程序员弄清楚发生了什么).我的想法只是用一堆'/'来勾勒出一段让我写下一些笔记,但也许有更好的方法？在Visual Studio中是否有内置方法可以执行此操作？

/////////////////////////////////////////////////////
//                                                 //
// KillZombies.cs                                  //
//                                                 //
// Description: This class contains blah blah blah //
//                                                 //  
/////////////////////////////////////////////////////

我对每段评论系统(也称为"注释系统")的新兴趋势非常感兴趣,例如由medium.com和qz.com实现的那些,我正在考虑开发一个用于我自己的.

问题:它们似乎主要是通过javascript实现的,它运行通过id属性唯一标识的文本的html段落(或者,在Medium的情况下,名称属性).这是否意味着他们的CMS实际上将每个段落存储为数据库中的单独条目？对我来说似乎过于复杂,但除此之外,他们如何管理段落可以在整个文本中删除,编辑或移动的事实？如果作者更改段落,如何保留唯一ID？这个唯一ID在逻辑上是如何构建的？(post_id + position_in_post)？

感谢您的见解......

我只是查看F#,如果这是一个愚蠢的问题,请道歉,但在VS2008 F#CTP 1.9.6.2'Tutorial'项目中,//和///都用于评论代码.

两个斜杠与三个斜杠注释之间是否存在功能差异,或者是否使用///对函数进行注释(并显示在教程代码中)并使用//用于其他所有内容？

我正在寻找记录我的C代码的"最佳实践".就像在任何项目中一样,我有一些头文件".h"和相应的源文件".c"

在头文件中你放了什么样的评论？在源文件中？问题出现了,因为我评论了我的头文件,c文件看起来像一团糟.

保持代码评论的最佳做法是什么？

我似乎无法使用CTRL+ SHIFT+ 在Android Studio中注释掉代码块7(在我的联想Yoga 2 Pro上没有Numpad,因此没有/自己的按钮上的字符).

按上面的组合会创建一个带有数字7的书签.

有没有人知道解决方法或我只是坚持/* *\？

重复

你评论的硬规则是什么？

我与之合作的开发人员有一些关于我感兴趣的评论的话题(见下文).您的个人做法/评论意见是什么？

"我不会在代码中添加注释,除非它是一个简单的标题,或者存在
平台错误或必要的解决方案,这是不明显的.代码可能会改变,注释可能会产生误导.代码应该
在使用时自我记录描述性的名称和其逻辑
的组织-和其解决方案应该是干净的/最简单的方法
,完成既定任务如果程序员不知道程序是什么
呢只阅读代码,那么他不准备改变它.
评论往往是写一些复杂
或非显而易见的东西- 我的目标是始终编写简洁明了的代码."

"我认为在评论方面存在一些阵营,那些认为他们正在编写API的企业级人员和一些将在未来几代使用的宏大代码库,这位工匠般的程序员认为代码说的是什么它比评论更清晰,并且新手编写详细/不清楚的代码,以便需要给自己留下笔记,告诉他们为什么要做某事."

我想像DjangoBook一样开源我的笔记.我没有在网站上找到任何类似的开源系统.我对垂直评论系统特别感兴趣.

这表明我需要自己构建一个开源软件.

你将如何在网站上建立类似的评论系统？

你在第二或第三人写评论吗？

// go somewhere and do something (2nd person comment)

要么

// goes somewhere and does something (3rd person comment) 

我总是(好好试试)评论我的代码.我已将配置我的服务器以在发送前删除这些注释/额外空格.最好不要在实时系统代码(Javascript/php)中发表评论,从而减少这种开销或删除或解释？

如果是这样我怎么能吃蛋糕呢？