用代码评论代替代码注释

在一个软件项目中，某些逻辑部分可能非常复杂，容易让人困惑。为了确保其他开发人员能够理解这些代码，同时也为了自己回顾时能够快速上手，我们通常会编写相关文档或添加大量注释来对这些复杂的逻辑进行解释。这样做的好处是能够提高代码的可读性和可维护性，进而提高整个项目的质量。

理想情况下，文档和注释应与代码逻辑保持同步，但实际上，代码和注释/文档往往不完全匹配。

文档和代码是两个独立的部分，需要花费额外的精力进行对齐。当修改代码和文档时，它们通常不在同一时间点进行，这可能会导致同步问题。使用注释可以解决一些问题，至少可以保证注释与代码足够接近。但是，每次修改代码时，都会导致版本变更，这会造成团队成员之间很难形成有效的互动。

我们需要能够在代码上进行有效的沟通，同时不影响代码版本。在代码上进行有效沟通的情况下，阅读代码上能获取更多有效信息，帮助理解代码。

安装凌鲨vscode插件

在vscode扩展里面搜索linksaas,找到插件并安装。

配置凌鲨vscode插件

方法一

安装完插件后需要项目下建立.linksaas.yml文件，并输入如下内容:

projectId: your_project_id

项目ID可以从凌鲨客户端获取到：

方法二

你可以通过本地仓库功能进行项目关联。

使用

评论保存在凌鲨对应的项目存储下，通常我们会在代码文件开头，每个类，方法入口处添加评论点。

添加评论点其实是添加了一个特殊形式的注释。在添加评论点后，后续代码上的讨论，就不会影响到代码版本了。