我正在使用 typescript 和 redux-toolkit (主要使用 createSlice)开发我的第一个应用程序。
看起来我正在使用今天被认为是良好实践的东西,但最终我发现它并不真正具有可读性(我指出我是一名经验丰富的开发人员,并且我练习过许多其他语言。刚刚接触 React Native ,然后我习惯了良好的编码实践和记录良好的代码),并且找不到从代码和注释生成有效文档的好方法(我尝试过 typedoc)。
有人对此有什么建议吗?最好是一个易于阅读的示例 redux-toolkit 切片文件?
为了说明这一点,下面是我的文件今天的样子的示例。我向减速器“refreshEventsList”添加了注释,但 typedoc 未将其检测为文档。
import {createAsyncThunk, createSlice, PayloadAction} from '@reduxjs/toolkit';
import {callAPI} from '../../api/APIManager';
export interface EventType {
id: string;
title: string;
}
interface EventsState {
events: EventType[];
}
const initialState = {events: []} as EventsState;
/**
* Load all events and update intern events data
*/
export const loadEvents = createAsyncThunk('events/fetchAll', async () => {
const response = await callAPI({path: 'api/test'});
return response.data as EventType[];
}); …Run Code Online (Sandbox Code Playgroud)