docs: 📝 更新文档中的图片链接和内容

Author: Ni0duann

docs/贡献文档/img/image-20250506215436489.png

@@ -1,6 +1,5 @@
 ## 如何联系我们：
 
-
 [EzStars团队](https://ezstars.github.io/EzMonitor/about.html)
 
 ## PR提交规范
@@ -9,4 +8,6 @@
 pnpm run commit
 ```
 
-![image.png](https://p0-xtjj-private.juejin.cn/tos-cn-i-73owjymdk6/273fcc171649452eb7dd23b856397e7e~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAgTmkwZHVhbm4=:q75.awebp?policy=eyJ2bSI6MywidWlkIjoiMzYzMTAyMzcwNjg2NTg5MiJ9&rk3s=e9ecf3d6&x-orig-authkey=f32326d3454f2ac7e96d3d06cdbb035152127018&x-orig-expires=1745380306&x-orig-sign=2wUxsLHZo9hA17516cNVbVWqJ78%3D)
+
+
+![image-20250506215436489](img/image-20250506215436489.png)

docs/贡献文档/index.md

@@ -2,6 +2,13 @@ export interface behaviorRecordsOptions {
   maxBehaviorRecords: number;
 }
 
+/**
+ * 行为记录的格式
+ * @param name 行为名称
+ * @param page 页面名称
+ * @param timestamp 时间戳
+ * @param value 行为参数
+ */
 export interface behaviorStack {
   name: string;
   page: string;
@@ -27,7 +34,7 @@ export default class BehaviorStore {
   // 从底部插入一个元素，且不超过 maxBehaviorRecords 限制数量
   push(value: behaviorStack) {
     if (this.length() === this.maxBehaviorRecords) {
-      this.shift();
+      this.shift(); // 超过最大数量，删除第一个元素
     }
     this.state.push(value);
   }

packages/monitor-sdk/src/plugins/behavior/behaviorStore.ts

@@ -17,20 +17,26 @@ import {
 } from '../../types';
 import BehaviorStore from './behaviorStore';
 import { proxyHash, proxyHistory, wrHistory } from './utils';
-
+/**
+ * 行为追踪
+ */
 export class Behavior {
   // 本地暂存数据在 Map 里 （也可以自己用对象来存储）
   public metrics: any;
 
+  // 行为追踪记录
   public breadcrumbs: any;
 
+  // 自定义埋点的信息一般立即上报
   public customHandler!: Function;
 
   // 最大行为追踪记录数
   public maxBehaviorRecords!: number;
 
   // 允许捕获click事件的DOM标签 eg:button div img canvas
   public clickMountList!: Array<string>;
+
+  // 初始化单例模式
   static instance: any;
 
   constructor() {
@@ -57,7 +63,10 @@ export class Behavior {
     Behavior.instance = this;
   }
 
-  // 初始化用户自定义埋点数据的获取上报
+  /**
+   * 初始化用户自定义埋点数据的获取上报
+   * @param reportData 自定义埋点数据
+   */
   initCustomerHandler = (): Function => {
     const handler = (reportData: customAnalyticsData) => {
       // 自定义埋点的信息一般立即上报

packages/monitor-sdk/src/plugins/behavior/index.ts

@@ -120,6 +120,12 @@ export type PerformanceResourceType = commonType & {
   pageUrl: string;
 };
 
+/**
+ * 错误信息
+ * @param errId 错误id
+ * @param state 错误状态
+ * @param timestamp 错误时间
+ */
 export type ErrorCommonType = {
   errId: string;
   state: any[];
@@ -133,6 +139,18 @@ export type ResourceErrorTarget = {
   outerHTML?: string;
 };
 
+/**
+ * 资源错误信息
+ * @param message 错误信息
+ * @param src 资源路径
+ * @param lineNo 错误行号
+ * @param columnNo 错误列号
+ * @param stack 错误堆栈
+ * @param pageUrl 页面路径
+ * @param tagName 标签名
+ * @param html 错误信息
+ * @param path 节点的dom位置
+ */
 export type ResourceErrorType = commonType &
   ErrorCommonType & {
     message: string | Event; // 错误信息
@@ -199,7 +217,10 @@ export type PageInformation = {
   pageLoadType: string;
 };
 
-// 这里参考了 谷歌GA 的自定义埋点上报数据维度结构
+/**
+ * 自定义埋点上报数据维度结构
+ * 这里参考了 谷歌GA 的自定义埋点上报数据维度结构
+ */
 export type customAnalyticsData = commonType & {
   // 埋点key
   eventKey: string;