conventions 相关问题

包含任何可接受的处理方法的通用标记,可包括命名,间距,编码,注释等。

Typescript:是否有用注释记录代码的约定?

我习惯以特定方式记录 C# 项目中的代码,以提高团队生产力,受益于 Visual Studio 中的 Intellisense 等。 代码看起来类似于: /// /// L... 我习惯以特定方式记录 C# 项目中的代码,以提高团队生产力,受益于 Visual Studio 中的 Intellisense 等。 代码看起来与此类似: /// <summary> /// Loads a user with a specific id. /// </summary> /// <param name="id">The id of the user to search for.</param> /// <returns>A user with the given id.</returns> public User GetUserById(string id) { ... } Typescript 是否有类似的注释和文档约定?或者甚至是使用这些约定从代码注释生成 html 文档页面的工具(如 JavaDoc)? TSDoc 是最新提议的 Typescript 源文件注释和文档约定。它的符号如下 - /** * Returns the average of two numbers. * * @remarks * This method is part of the {@link core-library#Statistics | Statistics subsystem}. * * @param x - The first input number * @param y - The second input number * @returns The arithmetic mean of `x` and `y` */ function getAverage(x: number, y: number): number { return (x + y) / 2.0; } TypeDoc工具可以解析此约定中的注释并生成 HTML 格式的文档页面。 是的,有。 最常用的注释约定(毫不奇怪)来自 jsdoc 形式的 javascript。例如,VSCode 支持它们开箱即用。 还有一些专门为打字稿文档生成而开发的工具,例如 typedoc

回答 2 投票 0

在设计用于显示相关和同级对象的 RESTful API 时如何优化性能并减少负载?

我目前正在开发一个前端应用程序,我需要在其中显示有关作者的信息。每个作者可以有多个子对象(例如书籍),我还需要显示信息...

回答 1 投票 0

设计用于显示相关和同级对象的 RESTful API 的最佳实践

我目前正在开发一个前端应用程序,我需要在其中显示有关作者的信息。每个作者可以有多个子对象(例如书籍),我还需要显示信息...

回答 1 投票 0

如何根据 Java 中的编码约定打破长行?

在Oracle关于编码约定的官方文档中他们写道: “以下是破坏算术表达式的两个示例。首选第一个,因为破坏发生在外部......

回答 6 投票 0

使用加载到静态文件中的不同环境变量来测试多个 pyspark 管道

好吧,我有一个问题- 背景信息:我是一名新 QA,在一个使用 pyspark 作为 ETL 引擎的团队中工作。 我使用 pytest 作为我的测试框架。 我们有多个管道(ETL,我将使用这个...

回答 1 投票 0

当操作上存在额外的 ProducesResponseType 属性时,不会继承 ASP.NET Core Web API 约定

请参考以下Web API约定以及对应的控制器: 公共静态类 MyAppConventions { [ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status404NotFound, ...

回答 1 投票 0

如何在 Forth 中对参数进行排序

在 Forth 中定义单词时选择参数顺序的一般规则(经验法则)是什么? 例如,在控制几个舵机的情况下,让我们定义SERVO!这将设置...

回答 2 投票 0

使用“”或<>

为什么元组文档说要使用,例如: #include“boost/tuple/tuple.hpp” 而不是 #包括 我知道我的代码不太可能有文件调用...

回答 6 投票 0

在 React 中使用 TypeScript 导出默认函数的最佳实践?

我目前正在使用 TypeScript 学习 React,并遇到了两种不同的方法来导出默认函数组件。这是两个例子: 单独导出函数: 功能

回答 1 投票 0

C 返回值约定(Bool 或 Err Code)

我知道这可能是一个负载问题,但在 C 中,返回带有错误代码的 int 或“成功”是更好的做法吗?布尔值。我注意到“0”代表成功似乎很常见......

回答 1 投票 0

您将 Rack 中间件文件和需求放在哪里?

我正在将 Rails 应用程序中内置的一些逻辑重构为中间件,我遇到的一个烦恼是似乎缺乏将它们放在哪里的约定。 目前我已经...

回答 8 投票 0

如果不创建额外的字段,是否应该装饰数据类子类

如果您不向子类添加更多字段,是否需要向其添加 @dataclass 装饰器,它会执行任何操作吗? 如果没有区别,通常的约定是什么? 来自

回答 2 投票 0

为什么atan2的参数是Y,X而不是X,Y?

在 C 语言中,atan2 函数具有以下签名: 双 atan2( 双 y, 双 x ); 其他语言也这样做。这是我所知道的唯一一个以 Y、X 顺序获取参数的函数

回答 7 投票 0

为什么 Lisp 风格指南在某些情况下建议使用特定数量的分号进行注释?

我在 Elisp 和 Common Lisp 的风格指南中读到在各种情况下使用特定数量的分号,简而言之: 代码行末尾的注释用单分号 双分号...

回答 1 投票 0

注册用户时在哪里设置默认值?

我目前正在开发一个网络应用程序,用户应该可以在其中注册。为此,我构建了一个 VueJS Web 应用程序和一个 Golang REST API。 然而,后端是n...

回答 1 投票 0

长格式数据框列层次结构

我正在使用长格式数据帧,并打算自己编写一个包。虽然这并不重要,但我想遵守列层次结构的常见做法,例如当我有 3 个参与者时...

回答 1 投票 0

Java 数组约定:String[] args 与 String args[]

我目前正在作为导师教授学生编程约定。我告诉他们,他们可以在 Oracle 代码约定中找到大多数约定。 在我的上一篇教程中,一位学生问是否: 噗...

回答 5 投票 0

为什么要在setter之前定义getter(编码约定)

我知道这个问题有点愚蠢,所以如果这是偏离主题或没有建设性的,我提前道歉。 为什么在 C# 中,在 ... 之前使用 getter 定义属性是标准约定*?

回答 5 投票 0

如何减少java中的重复错误处理

所以我有一个与此类似的代码片段。我觉得 if 语句应该在一个通用函数中。我不知道如何处理这个问题,因为学校和学生应该传递给这个函数......

回答 1 投票 0

使用 isdigit() 方法强制输入整数

以下代码按照惯例是否可以接受?以这种方式实现所需的解决方案可能会出现哪些问题? 而真实: Iq = 输入(“你的 Iq 是多少?...

回答 1 投票 0

© www.soinside.com 2019 - 2024. All rights reserved.