5.9 KiB
ਆਪਣੇ ਕੋਡ 'ਤੇ ਟਿੱਪਣੀ ਕਰੋ
ਹਦਾਇਤਾਂ
ਸਾਫ਼, ਵਧੀਆ ਦਸਤਾਵੇਜ਼ੀਕਰਨ ਵਾਲਾ ਕੋਡ ਆਪਣੇ ਪ੍ਰੋਜੈਕਟਾਂ ਨੂੰ ਸੰਭਾਲਣ ਅਤੇ ਸਾਂਝਾ ਕਰਨ ਲਈ ਬਹੁਤ ਜ਼ਰੂਰੀ ਹੈ। ਇਸ ਅਸਾਈਨਮੈਂਟ ਵਿੱਚ, ਤੁਸੀਂ ਪੇਸ਼ੇਵਰ ਡਿਵੈਲਪਰਾਂ ਦੀ ਇੱਕ ਮਹੱਤਵਪੂਰਨ ਆਦਤ ਦਾ ਅਭਿਆਸ ਕਰੋਗੇ: ਸਪਸ਼ਟ ਅਤੇ ਮਦਦਗਾਰ ਟਿੱਪਣੀਆਂ ਲਿਖਣਾ ਜੋ ਤੁਹਾਡੇ ਕੋਡ ਦੇ ਉਦੇਸ਼ ਅਤੇ ਕਾਰਗੁਜ਼ਾਰੀ ਨੂੰ ਸਮਝਾਉਂਦੀਆਂ ਹਨ।
ਆਪਣੇ ਗੇਮ ਫੋਲਡਰ ਵਿੱਚ ਮੌਜੂਦਾ app.js ਫਾਈਲ ਨੂੰ ਵੇਖੋ ਅਤੇ ਇਸ ਨੂੰ ਟਿੱਪਣੀ ਕਰਨ ਅਤੇ ਸਾਫ਼ ਕਰਨ ਦੇ ਤਰੀਕੇ ਲੱਭੋ। ਕੋਡ ਨੂੰ ਕਾਬੂ ਤੋਂ ਬਾਹਰ ਹੋਣਾ ਬਹੁਤ ਆਸਾਨ ਹੈ, ਅਤੇ ਹੁਣ ਇਹ ਇੱਕ ਵਧੀਆ ਮੌਕਾ ਹੈ ਟਿੱਪਣੀਆਂ ਸ਼ਾਮਲ ਕਰਨ ਦਾ ਤਾਂ ਜੋ ਤੁਹਾਡੇ ਕੋਡ ਨੂੰ ਪੜ੍ਹਨ ਯੋਗ ਬਣਾਇਆ ਜਾ ਸਕੇ ਅਤੇ ਤੁਸੀਂ ਇਸਨੂੰ ਬਾਅਦ ਵਿੱਚ ਵਰਤ ਸਕੋ।
ਤੁਹਾਡਾ ਕੰਮ ਸ਼ਾਮਲ ਹੈ:
- ਟਿੱਪਣੀਆਂ ਸ਼ਾਮਲ ਕਰੋ ਜੋ ਹਰ ਮੁੱਖ ਹਿੱਸੇ ਦੇ ਕੋਡ ਦਾ ਕੀ ਕਰਦਾ ਹੈ, ਇਹ ਸਮਝਾਉਂਦੀਆਂ ਹਨ
- ਫੰਕਸ਼ਨਾਂ ਨੂੰ ਦਸਤਾਵੇਜ਼ ਬਣਾਓ ਸਪਸ਼ਟ ਵਰਣਨ ਦੇ ਨਾਲ ਕਿ ਉਹ ਕੀ ਕਰਦੇ ਹਨ ਅਤੇ ਉਨ੍ਹਾਂ ਦੇ ਪੈਰਾਮੀਟਰ ਕੀ ਹਨ
- ਕੋਡ ਨੂੰ ਲਾਜ਼ਮੀ ਬਲਾਕਾਂ ਵਿੱਚ ਸੰਗਠਿਤ ਕਰੋ ਸੈਕਸ਼ਨ ਹੈਡਰ ਦੇ ਨਾਲ
- ਕੋਈ ਵੀ ਬੇਕਾਰ ਜਾਂ ਫਾਲਤੂ ਕੋਡ ਹਟਾਓ
- ਵਰਿਆਬਲਾਂ ਅਤੇ ਫੰਕਸ਼ਨਾਂ ਲਈ ਸਥਿਰ ਨਾਮਕਰਨ ਰੀਤਾਂ ਵਰਤੋ
ਰੂਬ੍ਰਿਕ
| ਮਾਪਦੰਡ | ਸ਼ਾਨਦਾਰ | ਯੋਗ | ਸੁਧਾਰ ਦੀ ਲੋੜ |
|---|---|---|---|
| ਕੋਡ ਦਸਤਾਵੇਜ਼ੀਕਰਨ | app.js ਕੋਡ ਪੂਰੀ ਤਰ੍ਹਾਂ ਟਿੱਪਣੀ ਕੀਤਾ ਗਿਆ ਹੈ ਸਪਸ਼ਟ, ਮਦਦਗਾਰ ਵਿਆਖਿਆਵਾਂ ਦੇ ਨਾਲ ਜੋ ਸਾਰੇ ਮੁੱਖ ਹਿੱਸਿਆਂ ਅਤੇ ਫੰਕਸ਼ਨਾਂ ਨੂੰ ਸਮਝਾਉਂਦੀਆਂ ਹਨ |
app.js ਕੋਡ ਯਥਾਧਿਕ ਟਿੱਪਣੀ ਕੀਤਾ ਗਿਆ ਹੈ ਜਿੱਥੇ ਜ਼ਰੂਰੀ ਹਿੱਸਿਆਂ ਲਈ ਬੁਨਿਆਦੀ ਵਿਆਖਿਆਵਾਂ ਦਿੱਤੀਆਂ ਗਈਆਂ ਹਨ |
app.js ਕੋਡ ਵਿੱਚ ਘੱਟ ਟਿੱਪਣੀਆਂ ਹਨ ਅਤੇ ਸਪਸ਼ਟ ਵਿਆਖਿਆਵਾਂ ਦੀ ਘਾਟ ਹੈ |
| ਕੋਡ ਸੰਗਠਨ | ਕੋਡ ਲਾਜ਼ਮੀ ਬਲਾਕਾਂ ਵਿੱਚ ਸੰਗਠਿਤ ਕੀਤਾ ਗਿਆ ਹੈ ਸਪਸ਼ਟ ਸੈਕਸ਼ਨ ਹੈਡਰ ਅਤੇ ਸਥਿਰ ਬਣਤਰ ਦੇ ਨਾਲ | ਕੋਡ ਵਿੱਚ ਕੁਝ ਸੰਗਠਨ ਹੈ ਜਿੱਥੇ ਸੰਬੰਧਿਤ ਕਾਰਗੁਜ਼ਾਰੀ ਨੂੰ ਬੁਨਿਆਦੀ ਤੌਰ 'ਤੇ ਸਮੂਹਬੱਧ ਕੀਤਾ ਗਿਆ ਹੈ | ਕੋਡ ਕੁਝ ਹੱਦ ਤੱਕ ਬੇਤਰਤੀਬ ਹੈ ਅਤੇ ਸਮਝਣ ਵਿੱਚ ਮੁਸ਼ਕਲ ਹੈ |
| ਕੋਡ ਗੁਣਵੱਤਾ | ਸਾਰੇ ਵਰਿਆਬਲ ਅਤੇ ਫੰਕਸ਼ਨ ਵਰਣਾਤਮਕ ਨਾਮ ਵਰਤਦੇ ਹਨ, ਕੋਈ ਬੇਕਾਰ ਕੋਡ ਨਹੀਂ ਹੈ, ਸਥਿਰ ਰੀਤਾਂ ਦੀ ਪਾਲਣਾ ਕੀਤੀ ਗਈ ਹੈ | ਜ਼ਿਆਦਾਤਰ ਕੋਡ ਚੰਗੇ ਨਾਮਕਰਨ ਅਭਿਆਸਾਂ ਦੀ ਪਾਲਣਾ ਕਰਦਾ ਹੈ ਅਤੇ ਘੱਟ ਬੇਕਾਰ ਕੋਡ ਹੈ | ਵਰਿਆਬਲਾਂ ਦੇ ਨਾਮ ਸਪਸ਼ਟ ਨਹੀਂ ਹਨ, ਬੇਕਾਰ ਕੋਡ ਸ਼ਾਮਲ ਹੈ, ਅਸਥਿਰ ਸ਼ੈਲੀ |
ਅਸਵੀਕਰਤਾ:
ਇਹ ਦਸਤਾਵੇਜ਼ AI ਅਨੁਵਾਦ ਸੇਵਾ Co-op Translator ਦੀ ਵਰਤੋਂ ਕਰਕੇ ਅਨੁਵਾਦ ਕੀਤਾ ਗਿਆ ਹੈ। ਜਦੋਂ ਕਿ ਅਸੀਂ ਸਹੀ ਹੋਣ ਦੀ ਕੋਸ਼ਿਸ਼ ਕਰਦੇ ਹਾਂ, ਕਿਰਪਾ ਕਰਕੇ ਧਿਆਨ ਦਿਓ ਕਿ ਸਵੈਚਾਲਿਤ ਅਨੁਵਾਦਾਂ ਵਿੱਚ ਗਲਤੀਆਂ ਜਾਂ ਅਸੁਚੀਤਤਾਵਾਂ ਹੋ ਸਕਦੀਆਂ ਹਨ। ਇਸ ਦੀ ਮੂਲ ਭਾਸ਼ਾ ਵਿੱਚ ਮੂਲ ਦਸਤਾਵੇਜ਼ ਨੂੰ ਅਧਿਕਾਰਤ ਸਰੋਤ ਮੰਨਿਆ ਜਾਣਾ ਚਾਹੀਦਾ ਹੈ। ਮਹੱਤਵਪੂਰਨ ਜਾਣਕਾਰੀ ਲਈ, ਪੇਸ਼ੇਵਰ ਮਨੁੱਖੀ ਅਨੁਵਾਦ ਦੀ ਸਿਫਾਰਸ਼ ਕੀਤੀ ਜਾਂਦੀ ਹੈ। ਇਸ ਅਨੁਵਾਦ ਦੀ ਵਰਤੋਂ ਤੋਂ ਪੈਦਾ ਹੋਣ ਵਾਲੇ ਕਿਸੇ ਵੀ ਗਲਤਫਹਿਮੀ ਜਾਂ ਗਲਤ ਵਿਆਖਿਆ ਲਈ ਅਸੀਂ ਜ਼ਿੰਮੇਵਾਰ ਨਹੀਂ ਹਾਂ।