代码整洁之道-注释

合集 - 代码整洁之道(10)

1.什么是一元函数2023-07-27 2.代码里如何try catch2023-07-31 3.代码格式有哪些注意事项2023-08-02 4.可测试代码特点2023-08-03

5. 代码整洁之道-注释2023-09-01

6.整洁代码格式2023-09-05 7.变量初始化方式2023-09-22 8.为什么不要返回null2023-12-05 9.如何精简变量名2023-12-07 10.优雅驾驭 TryParse：技巧与实战全攻略2024-12-26

提问

代码整洁之道-注释该怎么写

回答

WebApi接口写注释
实体写注释，标记example
方法不超过100行，自描述

posted @ 2023-09-01 14:11 东百牧码人阅读(8) 评论(0) 编辑收藏举报

刷新页面返回顶部

登录后才能查看或发表评论，立即登录或者逛逛博客园首页

【推荐】还在用 ECharts 开发大屏？试试这款永久免费的开源 BI 工具！
【推荐】国内首个AI IDE，深度理解中文开发场景，立即下载体验Trae
【推荐】编程新体验，更懂你的AI，立即体验豆包MarsCode编程助手
【推荐】抖音旗下AI助手豆包，你的智能百科全书，全免费不限次数
【推荐】轻量又高性能的 SSH 工具 IShell：AI 加持，快人一步

编辑推荐：
· 从 HTTP 原因短语缺失研究 HTTP/2 和 HTTP/3 的设计差异
· AI与.NET技术实操系列：向量存储与相似性搜索在 .NET 中的实现
· 基于Microsoft.Extensions.AI核心库实现RAG应用
· Linux系列：如何用heaptrack跟踪.NET程序的非托管内存泄露
· 开发者必知的日志记录最佳实践

阅读排行：
· TypeScript + Deepseek 打造卜卦网站：技术与玄学的结合
· Manus的开源复刻OpenManus初探
· AI 智能体引爆开源社区「GitHub 热点速览」
· C#/.NET/.NET Core技术前沿周刊 | 第 29 期（2025年3.1-3.9）
· 从HTTP原因短语缺失研究HTTP/2和HTTP/3的设计差异

历史上的今天：
2022-09-01 jenkins发布到nuget
2022-09-01 dotnet restore指定私有源
2022-09-01 VS创建新建项模板
2022-09-01 .NET Core读取配置文件姿势

公告

昵称：东百牧码人
园龄： 11年1个月
粉丝： 14
关注： 6

<

2025年3月

>

日

一

二

三

四

五

六

23

24

25

26

27

28

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

1

2

3

4

5

随笔分类

随笔档案

阅读排行榜

评论排行榜

推荐排行榜

最新评论

1. Re:blazor如何设置定时任务刷新页面
这才是正确做法,在你的page.razor.cs里面写 public partial class YourPage:IDisposable { private Timer? _timer; prote...
--MiuxuE
2. Re:blazor如何设置定时任务刷新页面
这是错误做法吧,Timer貌似不会被回收
--MiuxuE
3. Re:PostAsync假死
2种都会卡死。
--LiveCoding
4. Re:office加载项部署清单签名的证书或其位置不受信任
这篇文章对我很有用，谢谢。
--guy_1
5. Re:hahah
;ۣۣۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖۖ...
--阿研