ਟਿੱਪਣੀ ਪਰਿਵਰਤਨ ਟੂਲ ਨੂੰ ਬਲੌਕ ਕਰਨ ਲਈ VSCode JSDoc ਆਟੋਮੈਟਿਕ ਟੈਕਸਟ
JavaScript/TypeScript ਲਈ @example ਟੈਗ ਦੀ ਵਰਤੋਂ ਕਰਕੇ JSDoc ਟੈਕਸਟ ਲਾਈਨ ਬਰੇਕਾਂ ਨੂੰ ਜਲਦੀ ਹੱਲ ਕਰਨ ਲਈ ਇੱਕ ਸਹਾਇਕ ਟੂਲ JSDoc JavaScript ਲਈ ਇੱਕ ਸ਼ਕਤੀਸ਼ਾਲੀ ਦਸਤਾਵੇਜ਼ੀ ਜਨਰੇਟਰ ਹੈ। ਇਹ ਤੁਹਾਡੇ ਕੋਡ ਲਈ ਵਿਸਤ੍ਰਿਤ API ਦਸਤਾਵੇਜ਼ ਬਣਾਉਣ ਲਈ ਵਿਸ਼ੇਸ਼ ਤੌਰ 'ਤੇ ਫਾਰਮੈਟ ਕੀਤੀਆਂ ਟਿੱਪਣੀਆਂ ਦੀ ਵਰਤੋਂ ਕਰਦਾ ਹੈ। ਆਪਣੀਆਂ JavaScript ਫਾਈਲਾਂ ਵਿੱਚ JSDoc ਟਿੱਪਣੀਆਂ ਨੂੰ ਜੋੜ ਕੇ, ਤੁਸੀਂ ਆਪਣੇ ਫੰਕਸ਼ਨਾਂ, ਕਲਾਸਾਂ ਅਤੇ ਮੋਡੀਊਲਾਂ ਬਾਰੇ ਸਪਸ਼ਟ ਅਤੇ ਢਾਂਚਾਗਤ ਜਾਣਕਾਰੀ ਪ੍ਰਦਾਨ ਕਰ ਸਕਦੇ ਹੋ।
JSDoc ਦੀਆਂ ਮੁੱਖ ਵਿਸ਼ੇਸ਼ਤਾਵਾਂ:
ਜਾਣਕਾਰੀ ਟਾਈਪ ਕਰੋ
ਫੰਕਸ਼ਨ ਪੈਰਾਮੀਟਰ ਅਤੇ ਵਾਪਸੀ ਮੁੱਲ
ਕਲਾਸ ਅਤੇ ਵਿਧੀ ਦਾ ਵੇਰਵਾ
ਮੋਡੀਊਲ ਦਸਤਾਵੇਜ਼
JSDoc ਵਿੱਚ ਇੱਕ ਖਾਸ ਤੌਰ 'ਤੇ ਉਪਯੋਗੀ ਟੈਗ @ ਉਦਾਹਰਨ ਟੈਗ ਹੈ। ਇਹ ਟੈਗ ਤੁਹਾਨੂੰ ਤੁਹਾਡੇ ਦਸਤਾਵੇਜ਼ਾਂ ਵਿੱਚ ਕੋਡ ਉਦਾਹਰਨਾਂ ਸ਼ਾਮਲ ਕਰਨ ਦੀ ਇਜਾਜ਼ਤ ਦਿੰਦਾ ਹੈ। ਜੋ ਸਾਡੇ ਟੂਲ ਨੂੰ ਵੱਖਰਾ ਬਣਾਉਂਦਾ ਹੈ ਉਹ ਹੈ @example ਟੈਗ ਦੇ ਅੰਦਰ ਫਾਰਮੈਟਿੰਗ, ਇੰਡੈਂਟੇਸ਼ਨ, ਅਤੇ ਲਾਈਨ ਬਰੇਕਾਂ ਨੂੰ ਸੁਰੱਖਿਅਤ ਰੱਖਣ ਦੀ ਸਮਰੱਥਾ। ਇਸਦਾ ਮਤਲਬ ਹੈ ਕਿ ਤੁਸੀਂ ਵਧੇਰੇ ਪੜ੍ਹਨਯੋਗ ਅਤੇ ਯਥਾਰਥਵਾਦੀ ਕੋਡ ਉਦਾਹਰਨਾਂ ਲਿਖ ਸਕਦੇ ਹੋ, ਜਿਸ ਨਾਲ ਡਿਵੈਲਪਰਾਂ ਲਈ ਇਹ ਸਮਝਣਾ ਆਸਾਨ ਹੋ ਜਾਂਦਾ ਹੈ ਕਿ ਤੁਹਾਡੇ ਫੰਕਸ਼ਨਾਂ ਜਾਂ ਕਲਾਸਾਂ ਦੀ ਵਰਤੋਂ ਕਿਵੇਂ ਕਰਨੀ ਹੈ।
ਉਦਾਹਰਨ ਵਰਤੋਂ: /**
* Calculates the sum of two numbers.
* @param {number} a - The first number.
* @param {number} b - The second number.
* @returns {number} The sum of a and b.
* @example
* // This example preserves formatting and line breaks
* const result = add(5, 3);
* console.log(result);
* // Output: 8
*/
function add(a, b) {
return a + b;
} ਸਾਡੇ ਔਨਲਾਈਨ JSDoc ਟਿੱਪਣੀ ਜਨਰੇਟਰ ਦੀ ਵਰਤੋਂ ਕਰਕੇ, ਤੁਸੀਂ ਆਸਾਨੀ ਨਾਲ ਚੰਗੀ ਤਰ੍ਹਾਂ ਫਾਰਮੈਟ ਕੀਤੇ ਦਸਤਾਵੇਜ਼ ਬਣਾ ਸਕਦੇ ਹੋ ਜਿਸ ਵਿੱਚ ਤੁਹਾਡੇ ਕੋਡ ਉਦਾਹਰਨਾਂ ਵਿੱਚ ਸੁਰੱਖਿਅਤ ਫਾਰਮੈਟਿੰਗ ਸ਼ਾਮਲ ਹੁੰਦੀ ਹੈ, ਤੁਹਾਡੇ JavaScript ਦਸਤਾਵੇਜ਼ਾਂ ਨੂੰ ਵਧੇਰੇ ਸਪੱਸ਼ਟ ਅਤੇ ਪ੍ਰਭਾਵਸ਼ਾਲੀ ਬਣਾਉਂਦੇ ਹਨ।