百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 编程网 > 正文

vb.net和c井使用文档注释教程 vb.net c

yuyutoo 2024-10-12 01:33 4 浏览 0 评论

编辑好代码之后,在函数,类,方法,变量的开头连续输入三个单引号'(vb.net)或者三个///(c#)

1

2

3

这是c#的

要做的注释请写在><中间


  1. ''' <summary>
  2. ''' 函数的功能
  3. ''' </summary>
  4. ''' <param name="bit">bit变量的作用</param>
  5. ''' <param name="str">str变量的含义</param>
  6. ''' <param name="dt">dt变量的用法</param>
  7. ''' <returns>返回值是干嘛的</returns>
  8. Function func(bit As Integer, str As String, dt As Date) As String
  9. Return "成功执行"
  10. End Function

summary是总结,param是parameter的简写,代表参数,name是名字,returns是返回值。这样写好之后,又很多好处

1,自己看代码的时候轻松的知道代码的作用

2,别人看代码的时候轻松的知道代码的作用

3,引用代码的时候可以实现智能提示。(如下图所示)

如果一个函数不如它看起来那么容易懂,那么最好写上注释。

如果是团队协作,开发标准库等等,最后用这种文档注释

当函数变量返回值变动的时候,可能也要改变注释。

欢迎指正,评论

相关推荐

网站建设:从新手到高手

现代化网站应用领域非常广泛,从个人形象网站展示、企业商业网站运作、到政府公益等服务网站,各行各业都需要网站建设。大体上可以归结四类:宣传型网站设计、产品型网站制作、电子商务型网站建设、定制型功能网站开...

JetBrains 推出全新 AI 编程工具 Junie,助力高效开发

JetBrains宣布推出名为Junie的全新AI编程工具。这款工具不仅能执行简单的代码生成与检查任务,还能应对编写测试、验证结果等复杂项目,为开发者提供全方位支持。根据SWEBench...

AI也能写代码!代码生成、代码补全、注释生成、代码翻译轻松搞定

清华GLM技术团队打造的多语言代码生成模型CodeGeeX近期更新了新的开源版本「CodeGeeX2-6B」。CodeGeeX2是多语言代码生成模型CodeGeeX的第二代模型,不同于一代CodeG...

一键生成前后端代码,一个36k星的企业级低代码平台

「企业级低代码平台」前后端分离架构SpringBoot2.x,SpringCloud,AntDesign&Vue,Mybatis,Shiro,JWT。强大的代码生成器让前后端代码一键生成,无需写任...

Gitee 代码托管实战指南:5 步完成本地项目云端同步(附避坑要点)

核心流程拆解:远程仓库的搭建登录Gitee官网(注册账号比较简单,大家自行操作),点击“新建仓库”,建议勾选“初始化仓库”和“设置模板文件”(如.gitignore),避免上传临时文件。...

jeecg-boot 源码项目-强烈推荐使用

JEECGBOOT低代码开发平台...

JetBrains推出全新AI编程工具Junie,强调以开发者为中心

IT之家2月1日消息,JetBrains发文,宣布推出一款名为Junie的全新AI编程工具,官方声称这款AI工具既能执行简单的代码生成与检查等基础任务,也能应对“编写测试、验证结...

JetBrains旗下WebStorm和Rider现已加入“非商用免费”阵营

IT之家10月25日消息,软件开发商JetBrains今日宣布,旗下WebStorm(JavaScript开发工具)和Rider(.NET开发工具)现已加入“非商用免费”阵营。如果...

谈谈websocket跨域

了解websocketwebsocket是HTML5的新特性,在客户端和服务端提供了一个基于TCP连接的双向通道。...

websocket调试工具

...

利用webSocket实现消息的实时推送

1.什么是webSocketwebSocket实现实现推送消息WebSocket是HTML5开始提供的一种在单个TCP连接上进行全双工通讯的协议。以前的推送技术使用Ajax轮询,浏览器需...

Flutter UI自动化测试技术方案选型与探索

...

为 Go 开发的 WebSocket 库

#记录我的2024#...

「Java基础」Springboot+Websocket的实现后端数据实时推送

这篇文章主要就是实现这个功能,只演示一个基本的案例。使用的是websocket技术。...

【Spring Boot】WebSocket 的 6 种集成方式

介绍...

取消回复欢迎 发表评论: