مقدمه
این مقاله از داستان اصلی در مورد حاشیه نویسی زبان Arkts گزیده شده است ، و همه موارد مبتنی بر API13 است.
به اصطلاح حاشیه نویسی ، در توسعه و توضیح یک کد ، می تواند خوانایی کد را بهبود بخشد و به نگهدارنده های کد اجازه دهد تا سریعتر مداخله کنند ، اگر ما مبتدی هستیم ، باید اطلاعات را بخوانیم تا نقش و معنای هر ویژگی را بفهمیم.
Text(this.message)
.fontSize(50)
.fontWeight(FontWeight.Bold)
با این حال ، پس از اظهار نظر ، می توانید به طور شهودی معنای هر ویژگی را مشاهده کنید ، که عملکرد نظرات است.
Text(this.message)//设置展示的内容
.fontSize(50)//设置文字大小
.fontWeight(FontWeight.Bold)//设置文字字重
در توسعه واقعی ، توانایی استفاده از حاشیه نویسی به درستی و مناسب یک مهارت لازم برای هر توسعه دهنده است. بنابراین ، برای ادامه حفظ کد بدون موانع توسط خود و دیگران ، توصیه می شود که نظرات اضافه شود.
Arkts دو روش نظر را در اختیار ما قرار می دهد ، یکی یک نظر تک خط و دیگری یک نظر چند خطی است.
نظرات تک خط
این توضیحات ساده در مورد یک خط خاص از // استفاده می شود.
یک مثال ساده ارائه دهید
const a = 1 //声明一个常量a 赋值为1
const b = 2 //声明一个常量b 赋值为2
const c = a + b //声明一个常量c 赋值为 a+b 的和
//打印常量c的值
console.log("===" + c)
نظرات چند خطی
برای اظهار نظر چندین خط یا توضیحات طولانی تر ، و پایان دادن به مکانهایی که از نظرات چند خطی استفاده می شود ، بسیار متداول است.
یک مثال ساده ارائه دهید
/*
*以下的代码是用来计算常量a+常量b的和，
* 然后通过console进行打印出结果
**/
const a = 1
const b = 2
const c = a + b
console.log("===" + c)
البته ، شما همچنین می توانید “*” اضافی را در وسط حذف کنید.
/*
以下的代码是用来计算常量a+常量b的和，
然后通过console进行打印出结果
*/
const a = 1
const b = 2
const c = a + b
console.log("===" + c)
نظرات متغیر
نظرات متغیر را می توان با استفاده از نظرات تک خطی ، یا نظرات چند خطی و نظرات چند خطی انجام داد.
البته در توسعه ، ما همچنین باید از چنین قوانینی پیروی کنیم.
متغیرهای محلی ، نظرات تک خط:
const a = 1 //声明一个常量a 赋值为1
متغیرهای عضو ، نظرات تک خط:
@State message: string = '测试代码' //Text组件展示的内容
متغیرهای عضو ، نظرات چند خطی ، انواع متغیر و نسخه های قابل اجرا را می توان تنظیم کرد:
/**
* 是否显示
* @type { boolean }
* @since 11
*/
isShow?: boolean
نظرات عملکرد
در حقیقت ، نظرات عملکردی نیز نوعی از نظرات چند خطی است که برای توضیح توضیحات خاص یک عملکرد استفاده می شود.
add(a: number, b: number) {
const c = a + b
console.log("===" + c)
}
افراد باتجربه ممکن است عملکردهای فوق را در یک نگاه بدانند ، اما درک این کار با چنین کارکردهای ساده ای را درک می کند.
نظرات به طور کلی نیاز به توصیف عملکرد عملکرد دارد ، یعنی آنچه که این عملکرد برای آن استفاده می شود ، و همچنین پارامترها و انواع آن را حاشیه نویسی می کند ، و آیا این مقدار بازگشت دارد ، به یاد داشته باشید که آیا عملکرد فعلی به طور عادی استفاده می شود یا ممکن است ما نیز به نظرات خود بپردازیم.
بنابراین بر اساس شرایط فوق ، ما فقط در حال حاضر نظرات را به عملکرد جمع اضافه می کنیم.
/**
* 求两个值的和
* @param { number } a 任意 number 类型参数
* @param { number } b 任意 number 类型参数
*/
add(a: number, b: number) {
const c = a + b
console.log("===" + c)
}
هنگامی که نظرات وجود دارد ، وقتی روش را کلیک می کنیم ، می توانیم به طور شهودی از هدف روش بدانیم.
علاوه بر نظرات عادی ، ما همچنین می توانیم شماره نسخه قابل اجرا روش فعلی و اینکه آیا آن را منقضی می کند و غیره نیز مشخص کنیم تا تماس گیرنده بتواند واضح تر درک کند.
شماره نسخه را علامت گذاری کنید و از insh استفاده کنید.
/**
* 求两个值的和
* @param { number } a 任意 number 类型参数
* @param { number } b 任意 number 类型参数
* @since 12
*/
add(a: number, b: number) {
const c = a + b
console.log("===" + c)
}
روش حاشیه نویسی منسوخ شده است ، از deprecated استفاده کنید.
/**
* 求两个值的和
* @param { number } a 任意 number 类型参数
* @param { number } b 任意 number 类型参数
* @since 12
* @deprecated
*/
add(a: number, b: number) {
const c = a + b
console.log("===" + c)
}
پس از اتمام نشانگر ، حالت حذف خط هنگام فراخوانی روش ظاهر می شود ، به شرح زیر:
علاوه بر حاشیه نویسی پارامتر عادی ، وضعیت دیگری وجود دارد که به عنوان مثال ، عملکرد فوق را تغییر می دهیم.
/**
* 求两个值的和
* @param { number } a 任意 number 类型参数
* @param { number } b 任意 number 类型参数
* @returns { number } 返回两个number类型数据相加的和
*/
add(a: number, b: number): number {
return a + b
}
نظرات کلاس
حاشیه های به اصطلاح کلاس کاملاً متفاوت از حاشیه های روش است ، و آنها به طور عمده نقش کلاس فعلی را توصیف می کنند.
به شرح زیر ، این یک نظر کلاس بسیار رایج است.
/**
* AUTHOR:AbnerMing
* DATE:2025/01/16
* INTRODUCE:测试类，主要用于测试
* */
export class Test {
}
در نظرات کلاس ، شما همچنین می توانید نسخه را تنظیم کنید ، یا منقضی می شود و غیره ، و همان جمله یکسان است و موضوعات خاص را با جزئیات تجزیه و تحلیل کنید.
الگوی نظر
اگر برای ایجاد هر کلاس یا روش به صورت دستی نظرات خود را بنویسید ، خوشبختانه بسیار دست و پا گیر است.
نظرات روش
با روشی که باید اضافه شود ، ما یک نظر را به صورت خودکار برای ما ایجاد می کنیم.
اثرات پویا به شرح زیر است:
نظرات کلاس
الگوی اظهار نظر کلاس به طور پیش فرض در دسترس نیست ، می توانیم آن را در تنظیمات IDE اضافه کنیم ، صفحه تنظیمات را باز کنید ، گزینه های ویرایشگر را پیدا کنید ، روی الگوهای پرونده و کد کلیک کنید ، گزینه File Arkts را پیدا کنید و پس از کلیک ، می توانیم نظرات کلاس خود را در سمت راست بنویسیم.
از آنجا که به طور پیش فرض ، ما هنگام ایجاد پرونده های ETS کلاس نداریم ، می توانیم آنها را در اینجا تنظیم کنیم ، آنها را تنظیم کنیم و در آینده ، هنگام ایجاد پرونده های ETS ، به طور خودکار اضافه می شوند ، همانطور که در شکل زیر نشان داده شده است.
خلاصه
با توجه به نظرات ، نکته ای که باید به آنها توجه داشته باشید این است که توسط کامپایلر یا مترجم اجرا نمی شود.
گروه برنامه نویسان بسیار عجیب است.
مهم نیست که چه چیزی ، امیدوارم که هنگام مطالعه این مقاله ، بتوانید پرچم حاشیه نویسی برنامه نویس را حمل کنید و حاشیه نویسی را انجام دهید!
