Doxygen 1.8.5

ਡੌਕਸੀਜਨ - ਡਿਵੈਲਪਰਾਂ ਲਈ ਅੰਤਮ ਦਸਤਾਵੇਜ਼ੀ ਟੂਲ

ਇੱਕ ਡਿਵੈਲਪਰ ਵਜੋਂ, ਤੁਸੀਂ ਜਾਣਦੇ ਹੋ ਕਿ ਤੁਹਾਡੇ ਕੋਡ ਲਈ ਸਪਸ਼ਟ ਅਤੇ ਸੰਖੇਪ ਦਸਤਾਵੇਜ਼ ਹੋਣਾ ਕਿੰਨਾ ਮਹੱਤਵਪੂਰਨ ਹੈ। ਸਹੀ ਦਸਤਾਵੇਜ਼ਾਂ ਦੇ ਬਿਨਾਂ, ਤੁਹਾਡੇ ਕੋਡਬੇਸ ਦੀ ਬਣਤਰ ਨੂੰ ਸਮਝਣਾ ਮੁਸ਼ਕਲ ਹੋ ਸਕਦਾ ਹੈ, ਜਿਸ ਨਾਲ ਉਲਝਣ ਅਤੇ ਤਰੁੱਟੀਆਂ ਪੈਦਾ ਹੋ ਸਕਦੀਆਂ ਹਨ। ਇਹ ਉਹ ਥਾਂ ਹੈ ਜਿੱਥੇ ਡੌਕਸੀਜਨ ਆਉਂਦਾ ਹੈ - ਇੱਕ ਸ਼ਕਤੀਸ਼ਾਲੀ ਟੂਲ ਜੋ ਤੁਹਾਡੀਆਂ ਸਰੋਤ ਫਾਈਲਾਂ ਤੋਂ ਔਨ-ਲਾਈਨ ਦਸਤਾਵੇਜ਼ੀ ਬ੍ਰਾਊਜ਼ਰ ਅਤੇ ਔਫ-ਲਾਈਨ ਰੈਫਰੈਂਸ ਮੈਨੂਅਲ ਤਿਆਰ ਕਰ ਸਕਦਾ ਹੈ।

Doxygen ਇੱਕ ਮੁਫਤ ਅਤੇ ਓਪਨ-ਸੋਰਸ ਸਾਫਟਵੇਅਰ ਹੈ ਜੋ ਕਿ 1997 ਤੋਂ ਚੱਲ ਰਿਹਾ ਹੈ। ਇਹ ਵਰਤੋਂ ਵਿੱਚ ਆਸਾਨੀ, ਲਚਕਤਾ, ਅਤੇ ਸ਼ਕਤੀਸ਼ਾਲੀ ਵਿਸ਼ੇਸ਼ਤਾਵਾਂ ਦੇ ਕਾਰਨ ਡਿਵੈਲਪਰਾਂ ਵਿੱਚ ਸਭ ਤੋਂ ਪ੍ਰਸਿੱਧ ਦਸਤਾਵੇਜ਼ੀ ਸਾਧਨਾਂ ਵਿੱਚੋਂ ਇੱਕ ਬਣ ਗਿਆ ਹੈ। Doxygen ਦੇ ਨਾਲ, ਤੁਸੀਂ ਆਪਣੇ ਪ੍ਰੋਜੈਕਟਾਂ ਲਈ ਆਪਣੇ ਆਪ ਨੂੰ ਲਿਖਣ ਦੇ ਘੰਟੇ ਬਿਤਾਏ ਬਿਨਾਂ ਆਸਾਨੀ ਨਾਲ ਪੇਸ਼ੇਵਰ ਦਿੱਖ ਵਾਲੇ ਦਸਤਾਵੇਜ਼ ਬਣਾ ਸਕਦੇ ਹੋ।

ਡੌਕਸੀਜਨ ਦੀਆਂ ਮੁੱਖ ਵਿਸ਼ੇਸ਼ਤਾਵਾਂ ਵਿੱਚੋਂ ਇੱਕ ਤੁਹਾਡੀ ਸਰੋਤ ਫਾਈਲਾਂ ਤੋਂ ਸਿੱਧੇ ਦਸਤਾਵੇਜ਼ਾਂ ਨੂੰ ਐਕਸਟਰੈਕਟ ਕਰਨ ਦੀ ਯੋਗਤਾ ਹੈ। ਇਸਦਾ ਮਤਲਬ ਹੈ ਕਿ ਤੁਹਾਨੂੰ ਵੱਖਰੇ ਦਸਤਾਵੇਜ਼ ਫਾਈਲਾਂ ਲਿਖਣ ਜਾਂ ਉਹਨਾਂ ਨੂੰ ਆਪਣੇ ਕੋਡਬੇਸ ਤੋਂ ਵੱਖਰੇ ਤੌਰ 'ਤੇ ਰੱਖਣ ਦੀ ਲੋੜ ਨਹੀਂ ਹੈ। ਇਸਦੀ ਬਜਾਏ, ਤੁਸੀਂ ਸਿਰਫ਼ ਵਿਸ਼ੇਸ਼ ਟੈਗਸ ਦੀ ਵਰਤੋਂ ਕਰਕੇ ਆਪਣੀਆਂ ਸਰੋਤ ਫਾਈਲਾਂ ਵਿੱਚ ਟਿੱਪਣੀਆਂ ਜੋੜਦੇ ਹੋ ਜੋ Doxygen ਪਛਾਣਦਾ ਹੈ।

ਇਹ ਟੈਗ ਤੁਹਾਨੂੰ ਤੁਹਾਡੇ ਕੋਡ ਦੇ ਵੱਖ-ਵੱਖ ਪਹਿਲੂਆਂ ਜਿਵੇਂ ਕਿ ਫੰਕਸ਼ਨ, ਕਲਾਸਾਂ, ਵੇਰੀਏਬਲ ਅਤੇ ਹੋਰ ਬਹੁਤ ਕੁਝ ਦਸਤਾਵੇਜ਼ ਕਰਨ ਦੀ ਇਜਾਜ਼ਤ ਦਿੰਦੇ ਹਨ। ਤੁਸੀਂ ਪੈਰਾਮੀਟਰਾਂ, ਵਾਪਸੀ ਮੁੱਲਾਂ, ਫੰਕਸ਼ਨਾਂ ਜਾਂ ਤਰੀਕਿਆਂ ਦੁਆਰਾ ਸੁੱਟੇ ਗਏ ਅਪਵਾਦ ਆਦਿ ਬਾਰੇ ਜਾਣਕਾਰੀ ਵੀ ਸ਼ਾਮਲ ਕਰ ਸਕਦੇ ਹੋ, ਜਿਸ ਨਾਲ ਦੂਜੇ ਡਿਵੈਲਪਰਾਂ (ਜਾਂ ਆਪਣੇ ਆਪ) ਲਈ ਇਹ ਸਮਝਣਾ ਆਸਾਨ ਹੋ ਜਾਂਦਾ ਹੈ ਕਿ ਕੋਡ ਕਿਵੇਂ ਕੰਮ ਕਰਦਾ ਹੈ।

ਇੱਕ ਵਾਰ ਜਦੋਂ ਤੁਸੀਂ ਆਪਣੀਆਂ ਸਰੋਤ ਫਾਈਲਾਂ ਵਿੱਚ ਇਹਨਾਂ ਟਿੱਪਣੀਆਂ ਨੂੰ ਸ਼ਾਮਲ ਕਰ ਲੈਂਦੇ ਹੋ (ਜੋ ਪਹਿਲਾਂ ਤਾਂ ਔਖਾ ਜਾਪਦਾ ਹੈ ਪਰ ਸਪੇਡਾਂ ਵਿੱਚ ਭੁਗਤਾਨ ਕਰਦਾ ਹੈ), Doxygen ਚਲਾਉਣਾ ਹਰੇਕ ਫੰਕਸ਼ਨ/ਕਲਾਸ/ਵੇਰੀਏਬਲ/ਆਦਿ ਬਾਰੇ ਸਾਰੀ ਸੰਬੰਧਿਤ ਜਾਣਕਾਰੀ ਦੇ ਨਾਲ ਇੱਕ HTML-ਆਧਾਰਿਤ ਬ੍ਰਾਊਜ਼ਰ ਇੰਟਰਫੇਸ ਤਿਆਰ ਕਰੇਗਾ। , ਕਿਸੇ ਵੀ ਸੰਬੰਧਿਤ ਚਿੱਤਰਾਂ ਜਿਵੇਂ ਕਿ ਵਿਰਾਸਤੀ ਰੁੱਖ ਜਾਂ ਸਹਿਯੋਗੀ ਚਿੱਤਰਾਂ ਸਮੇਤ।

ਪਰ ਕੀ ਜੇ ਕੋਡ ਦੇ ਕੁਝ ਹਿੱਸੇ ਦਸਤਾਵੇਜ਼ੀ ਨਹੀਂ ਹਨ? ਕੋਈ ਸਮੱਸਿਆ ਨਹੀ! ਡੌਕਸੀਜਨ ਦੇ ਸੰਰਚਨਾ ਵਿਕਲਪਾਂ (ਜੋ ਕਿ ਵਿਆਪਕ ਹਨ) ਦੇ ਨਾਲ, ਤੁਸੀਂ ਇਸਨੂੰ ਦੱਸ ਸਕਦੇ ਹੋ ਕਿ ਕਿਸ ਤਰ੍ਹਾਂ ਵੀ ਤਿਆਰ ਕੀਤੇ ਆਉਟਪੁੱਟ ਵਿੱਚ ਗੈਰ-ਦਸਤਾਵੇਜ਼ੀ ਭਾਗਾਂ ਨੂੰ ਸ਼ਾਮਲ ਕੀਤਾ ਜਾਣਾ ਚਾਹੀਦਾ ਹੈ - ਇਸ ਤਰ੍ਹਾਂ ਭਾਵੇਂ ਕੁਝ ਖੇਤਰਾਂ ਬਾਰੇ ਗਿਆਨ ਵਿੱਚ ਅੰਤਰ ਹੋਣ ਦੇ ਬਾਵਜੂਦ ਉਹ ਬ੍ਰਾਊਜ਼ ਕਰਨ ਵੇਲੇ ਦੇਖਣ ਤੋਂ ਪੂਰੀ ਤਰ੍ਹਾਂ ਗਾਇਬ ਨਹੀਂ ਹੋਣਗੇ। ਡਾਊਨ-ਦੀ-ਲਾਈਨ 'ਤੇ ਬਾਅਦ ਵਿੱਚ ਤਿਆਰ ਕੀਤੇ ਦਸਤਾਵੇਜ਼!

Doxygen ਦੀ ਇੱਕ ਹੋਰ ਵੱਡੀ ਵਿਸ਼ੇਸ਼ਤਾ ਵੱਖ-ਵੱਖ ਫਾਰਮੈਟਾਂ ਜਿਵੇਂ ਕਿ RTF (MS-Word), PostScript/PDFs/ਹਾਈਪਰਲਿੰਕਡ PDFs/ਕੰਪਰੈੱਸਡ HTML/ਯੂਨਿਕਸ ਮੈਨ ਪੇਜ ਆਦਿ ਵਿੱਚ ਆਉਟਪੁੱਟ ਤਿਆਰ ਕਰਨ ਲਈ ਇਸਦਾ ਸਮਰਥਨ ਹੈ। ਇਸਦਾ ਮਤਲਬ ਹੈ ਕਿ ਕੋਈ ਵੀ ਵਿਅਕਤੀ ਆਪਣੇ ਦਸਤਾਵੇਜ਼ਾਂ ਨੂੰ ਤਰਜੀਹ ਦਿੰਦਾ ਹੈ। ਵਿੱਚ ਉਹ ਸੰਭਾਵਤ ਤੌਰ 'ਤੇ ਇੱਥੇ ਕੁਝ ਢੁਕਵਾਂ ਲੱਭਣਗੇ!

ਪਹਿਲਾਂ ਜ਼ਿਕਰ ਕੀਤੇ ਗਏ ਸੰਮਿਲਨ ਨਿਰਭਰਤਾ ਗ੍ਰਾਫ਼ ਇੱਕ ਹੋਰ ਵਧੀਆ ਵਿਸ਼ੇਸ਼ਤਾ ਹਨ: ਇਹ ਦਰਸਾਉਂਦੇ ਹਨ ਕਿ ਕਿਵੇਂ ਇੱਕ ਪ੍ਰੋਜੈਕਟ ਦੇ ਅੰਦਰ ਵੱਖ-ਵੱਖ ਤੱਤ ਦ੍ਰਿਸ਼ਟੀਗਤ ਤੌਰ 'ਤੇ ਆਪਸ ਵਿੱਚ ਜੁੜੇ ਹੋਏ ਹਨ ਤਾਂ ਜੋ ਉਪਭੋਗਤਾਵਾਂ ਨੂੰ ਛੇਤੀ ਹੀ ਇੱਕ ਵਿਚਾਰ ਪ੍ਰਾਪਤ ਹੋ ਜਾਵੇ ਜਿੱਥੇ ਹਰ ਇੱਕ ਲਾਈਨ ਨੂੰ ਪਹਿਲਾਂ ਤੋਂ ਪਹਿਲਾਂ ਪੜ੍ਹੇ ਬਿਨਾਂ ਸਭ ਕੁਝ ਜਗ੍ਹਾ ਵਿੱਚ ਫਿੱਟ ਹੁੰਦਾ ਹੈ; ਇਹ ਸਮੇਂ ਦੀ ਬਚਤ ਕਰਦਾ ਹੈ ਖਾਸ ਤੌਰ 'ਤੇ ਜਦੋਂ ਬਹੁਤ ਸਾਰੇ ਅੰਤਰ-ਨਿਰਭਰ ਭਾਗਾਂ ਵਾਲੇ ਵੱਡੇ ਪ੍ਰੋਜੈਕਟਾਂ ਨਾਲ ਕੰਮ ਕਰਦੇ ਹਨ।

ਵਿਰਾਸਤੀ ਚਿੱਤਰ ਕਲਾਸਾਂ/ਇੰਟਰਫੇਸਾਂ/ਆਦਿ ਵਿਚਕਾਰ ਸਬੰਧਾਂ ਨੂੰ ਦਿਖਾ ਕੇ ਸਮਾਨ ਲਾਭ ਪ੍ਰਦਾਨ ਕਰਦੇ ਹਨ, ਜਦੋਂ ਕਿ ਸਹਿਯੋਗੀ ਚਿੱਤਰ ਉਹਨਾਂ ਹੀ ਕਲਾਸਾਂ/ਇੰਟਰਫੇਸਾਂ/ਆਦਿ ਦੇ ਅੰਦਰ ਵੱਖ-ਵੱਖ ਵਸਤੂਆਂ ਵਿਚਕਾਰ ਪਰਸਪਰ ਪ੍ਰਭਾਵ ਦਿਖਾਉਂਦੇ ਹਨ। ਤਿੰਨੋਂ ਕਿਸਮਾਂ ਕਈ ਮਾਡਿਊਲਾਂ ਵਿੱਚ ਖਿੰਡੇ ਹੋਏ ਸੰਦਰਭ ਤੋਂ ਬਾਹਰ ਦੇ ਸਨਿੱਪਟ ਨੂੰ ਸਮਝਣ ਵਿੱਚ ਮਦਦ ਕਰਦੀਆਂ ਹਨ। /files/folders/etc..

ਸਮੁੱਚੇ ਤੌਰ 'ਤੇ ਫਿਰ ਅਸੀਂ ਡੌਕਸੀਜੇਨ ਨੂੰ ਅਜ਼ਮਾਉਣ ਦੀ ਜ਼ੋਰਦਾਰ ਸਿਫਾਰਸ਼ ਕਰਦੇ ਹਾਂ ਜੇਕਰ ਵਰਤੋਂ ਵਿੱਚ ਆਸਾਨ ਪਰ ਸ਼ਕਤੀਸ਼ਾਲੀ ਟੂਲ ਦੀ ਭਾਲ ਕਰ ਰਹੇ ਹੋ ਜੋ ਉੱਚ-ਗੁਣਵੱਤਾ ਵਾਲੇ ਦਸਤਾਵੇਜ਼ਾਂ ਨੂੰ ਤੇਜ਼ੀ ਅਤੇ ਕੁਸ਼ਲਤਾ ਨਾਲ ਤਿਆਰ ਕਰਨ ਦੇ ਸਮਰੱਥ ਹੈ!