编辑好代码之后,在函数,类,方法,变量的开头连续输入三个单引号'(vb.net)或者三个///(c#)
1
2
3
这是c#的
要做的注释请写在><中间
- ''' <summary>
- ''' 函数的功能
- ''' </summary>
- ''' <param name="bit">bit变量的作用</param>
- ''' <param name="str">str变量的含义</param>
- ''' <param name="dt">dt变量的用法</param>
- ''' <returns>返回值是干嘛的</returns>
- Function func(bit As Integer, str As String, dt As Date) As String
- Return "成功执行"
- End Function
summary是总结,param是parameter的简写,代表参数,name是名字,returns是返回值。这样写好之后,又很多好处
1,自己看代码的时候轻松的知道代码的作用
2,别人看代码的时候轻松的知道代码的作用
3,引用代码的时候可以实现智能提示。(如下图所示)
如果一个函数不如它看起来那么容易懂,那么最好写上注释。
如果是团队协作,开发标准库等等,最后用这种文档注释
当函数变量返回值变动的时候,可能也要改变注释。
欢迎指正,评论
本文暂时没有评论,来添加一个吧(●'◡'●)