TypeScript yorumlarının sözdizimi herhangi bir yerde belgeleniyor mu?

Ve herhangi bir şansla, şimdi C # ///sistemini destekliyor mu?

Doğru sözdizimi artık TSDoc tarafından kullanılan sözdizimidir . Yorumlarınızın Visual Studio Code veya diğer dokümantasyon araçlarıyla anlaşılmasını sağlayacaktır.

Sözdizimine iyi bir genel bakış burada ve özellikle burada mevcuttur . Kesin özellik "yakında" yazılmalıdır .

Kontrol Başka dosya değer bu bir kullanışlı standart etiketler göreceksiniz.

Not : TSDoc ana sayfasında açıklandığı gibi JSDoc kullanmamalısınız: JSDoc neden standart olamaz? Ne yazık ki, JSDoc dilbilgisi titizlikle belirtilmez, belirli bir uygulamanın davranışından çıkarılır. Standart JSDoc etiketlerinin çoğu, düz JavaScript için tür ek açıklamaları sağlayarak meşgul olur; bu, TypeScript gibi güçlü yazılan bir dil için ilgisiz bir konudur. TSDoc, daha karmaşık hedefleri de ele alırken bu sınırlamalara da cevap vermektedir.

gelecek

TypeScript ekibi ve diğer TypeScript ekipleri, standart bir resmi TSDoc belirtimi oluşturmayı planlıyor. 1.0.0Taslak henüz verilmemiş olmasına: https://github.com/Microsoft/tsdoc#where-are-we-on-the-roadmap

şimdiki

TypeScript JSDoc kullanır. Örneğin

/** This is a description of the foo function. */
function foo() {
}

Jsdoc'u öğrenmek için: https://jsdoc.app/

Ancak JSDoc'da tür ek açıklama uzantılarını kullanmanıza gerek yoktur.

Hala vb. Gibi diğer jsdoc blok etiketlerini kullanabilirsiniz (ve kullanmalısınız) @returns.

Misal

Sadece bir örnek. Türlere odaklanın (içeriğe değil).

JSDoc sürümü (dokümanlardaki bildirim türleri):

/**
 * Returns the sum of a and b
 * @param {number} a
 * @param {number} b
 * @returns {number}
 */
function sum(a, b) {
    return a + b;
}

TypeScript sürümü (türlerin yeniden konumlandırıldığına dikkat edin):

/**
 * Takes two numbers and returns their sum
 * @param a first input to sum
 * @param b second input to sum
 * @returns sum of a and b
 */
function sum(a: number, b: number): number {
    return a + b;
}

Aşağıdakileri kullanarak parametreler, iadeler vb. Hakkında bilgi ekleyebilirsiniz:

/**
* This is the foo function
* @param bar This is the bar parameter
* @returns returns a string version of bar
*/
function foo(bar: number): string {
    return bar.toString()
}

Bu, VS Kodu gibi editörlerin aşağıdaki gibi göstermesine neden olacaktır:

Normal JavaScript'teki gibi yorumları kullanabilirsiniz:

TypeScript sözdizimi, Ecmascript 5 (ES5) sözdiziminin bir üst kümesidir. [...]

Bu belgede, TypeScript tarafından eklenen sözdizimsel dilbilgisi açıklanmaktadır

Bunun dışında, ben sadece dil özellikleri yorumlar hakkında buldum:

TypeScript ayrıca JavaScript programcılarına isteğe bağlı tür ek açıklamaları sistemi de sağlar . Bu tür ek açıklamalar Kapatma sisteminde bulunan JSDoc yorumları gibidir, ancak TypeScript'te doğrudan dil sözdizimiyle tümleştirilir. Bu entegrasyon kodu daha okunabilir hale getirir ve tip ek açıklamalarını karşılık gelen değişkenlerle senkronize etmenin bakım maliyetini azaltır.

11.1.1 Kaynak Dosya Bağımlılıkları:

Formun yorumu /// <reference path="..."/> , yol bağımsız değişkeninde belirtilen kaynak dosyaya bir bağımlılık ekler. Yol, içerdiği kaynak dosyanın dizinine göre çözümlenir

Kaynak:
https://github.com/Microsoft/TypeScript/blob/master/doc/spec.md

TypeScript, JavaScript'in katı bir sözdizimsel üst kümesidir.

• Tek satırlı yorumlar // ile başlar
• Çok satırlı yorumlar / * ile başlar ve * / ile biter