আমি অন্যান্য পরিবেশ সম্পর্কে জানি না তবে যখন বড় (প্রায়শই ওপেন সোর্স) পিএইচপি প্রকল্পগুলি আসে যখন অন্য লোকেরা লিখে থাকে, পিএইচপিএক্সআরএফ একটি পরম জীবন রক্ষাকারী (বিশেষত যদি ডকটি অনলাইনে রাখা হয় এবং গুগল এটি সূচক করতে পারে)।
এমনকি একটি খারাপ মন্তব্য করা প্রকল্প কমপক্ষে আমাকে কোথায় জিনিস সংজ্ঞায়িত করা হয়েছে এবং সেগুলি কোথায় ব্যবহৃত হয়েছে তা সনাক্ত করতে সহায়তা করতে পারে (উদাহরণস্বরূপ রিফ্যাক্টরিং করার সময়)।
যখন ভাল মন্তব্য করা হয়, ফলাফল পৃষ্ঠাগুলি কোডবেস (যাইহোক আমার ব্যবহারের জন্য) একটি নিখুঁত বাইবেলের কাছাকাছি গঠন করে।
তদুপরি, আমার পছন্দসই আইডিই মন্তব্য ব্লকটি (যদি আমি টাইপ করি / **) স্বয়ংক্রিয়ভাবে উত্পন্ন করে যা আমার পক্ষে মন্তব্য করার কাজটির প্রায় 75% কাজ করে। আমি আশ্চর্যজনক যে আমার কোডার জীবদ্দশায় আমাকে কতগুলি বোকা কাজ করা থেকে বিরত করা হয়েছে কেবল কারণ আমি অন্যান্য লোকদের (এবং ভবিষ্যতে আমাকে) আমি কী করছি তা বোঝাতে হয়েছিল। যখন ডক জেনারেটরের জন্য আমার মন্তব্যটি পদ্ধতির চেয়ে বড় হয় তবে এর অর্থ সাধারণত আমার কাছে পর্যাপ্ত কফি নেই এবং কিছুটা কঠিন ভাবতে চাই।
এই স্ব-একই মন্তব্য ব্লকগুলি ইনলাইন সমাপ্তি "সহায়তা" পাঠ্যটিও তৈরি করে যাতে আমি ফাংশন কলটি লেখার সময় ঠিক কী প্রত্যাশিত হয়েছিল (অন্যান্য কোডারদের দ্বারা) তা দেখতে পাচ্ছি। এটি আমার পক্ষে একটি বিশাল উত্পাদনশীলতা বৃদ্ধি (বিশেষত সেই বিরল প্রান্তের ক্ষেত্রে যেখানে অন্য কোনও সহায়ক বিকাশকারী "ভাল কাজের জন্য করুন / করুন না এক্স" লিখেছেন - যা প্রচুর ব্যথা বাঁচাতে পারে।
জটিল (এবং প্রায়শই খারাপ নাম দেওয়া) পিএইচপি প্রকল্পগুলিতে এবং কম ঘন ঘন ব্যবহৃত পদ্ধতিতে যুক্তির অর্ডারে নির্দিষ্ট হওয়া প্রত্যাশিত ইনপুট ধরণের কতটা কার্যকর তা আমি যথেষ্ট চাপ দিতে পারি না। এমনকি আমার নিজের কোড সহ, আমি সবসময় মনে করতে পারি না আমি কোনও যুগে স্পর্শ করি নি এমন কিছুর জন্য আমি কী যুক্তিগুলি নির্দিষ্ট করেছিলাম।
একটি উদাহরণে এর অর্থ হ'ল যে পুনরাবৃত্ত সমস্যাগুলির উত্সটি হ'ল কোনও কারণে যা পূর্ব বিকাশকারীদের উপর খারাপভাবে প্রতিবিম্বিত করে, কিছু ফাংশন এবং এমনকি ধ্রুবকগুলি একটি বিশাল সংখ্যক স্থানে সংজ্ঞায়িত করা হয়েছিল (যুক্ত "মজাদার" জন্য কিছুটা অসঙ্গতি সহ) । প্রকল্প থেকে দূরে সরে যাওয়ার লক্ষণ এটি ছিল।
আমি যোগদানের আগে শুরু হওয়া বৃহত্তর প্রকল্পগুলিতে আমি দেখতে পাচ্ছি যে কোন বিকাশকারী (তারা নাম এবং ইমেলের সাথে ক্লাস ফাইলটি ট্যাগ করে ধরেছিল) বর্গ তৈরি করেছে এবং কেবল সঠিক বিকাশকারীকে সন্ধান করতে এবং কথা বলতে সক্ষম হওয়া অত্যন্ত সহায়ক।
স্বয়ংক্রিয় টাস্কের তালিকা - @ টডো ট্যাগ ব্যবহার করে (আমি যে ধরণের প্রকল্পে নিজেকে কাজ করছি বলে মনে হচ্ছে) এর অর্থ হ'ল ডকুমেন্টেশনটি এমন স্টাফের উপর নজর রাখতে পারে যাতে আরও কিছু কাজের প্রয়োজন হয় (বা এমন বৈশিষ্ট্য যা নিখোঁজ বলে স্বীকৃত)। আবার আমার আইডিই এটির খোঁজ রাখে এবং এটিই প্রথমে আমার মনোযোগের প্রয়োজনের বিষয়ে ভাল গাইড হিসাবে কাজ করে।
শেষ অবধি (এবং আমার কাছে অত্যন্ত গুরুত্বপূর্ণ) এটি সমস্ত লেখার অ-তুচ্ছ ওভারহেড সরিয়ে দেয় এবং তখন কিছু (অনেকগুলি পড়ুন) কোডার পরিবর্তন করে এবং ডকুমেন্টেশন রক্ষণাবেক্ষণকারীদের সাথে কথা না বলে এটিকে আপডেট রাখার চেষ্টা করে।
সুতরাং, কারণগুলির মধ্যে রয়েছে:
- পরে বিকাশকারীদের অনেকটা সময় সঞ্চয় করা,
- ফাংশনগুলি কোথায় ডাকা হয় তার ট্র্যাক রাখা (এবং সংজ্ঞায়িত),
- নির্বোধ কোডিং স্পটিং,
- যখন কিছু স্পষ্টতই অনুপস্থিত তখন সন্ধান করা (অন্য একজন যেমন উল্লেখ করেছেন),
- সরলকরণের রিফ্যাক্টরিং (খুব বেশি মজাদার নয়)
- (অনেক ক্ষেত্রে) বিকাশকারী কী করার চেষ্টা করছে সে সম্পর্কে ধারণা পাওয়া (তিনি ধরে নিলেন তিনি কিছু নোট রেখেছেন)।
- প্রকল্পটি যদি একাধিক লাইসেন্স চলার পক্ষে যথেষ্ট জটিল হয় (কোনও মজা নেই) আমি দ্রুত দেখতে পাচ্ছি কোন প্রদত্ত বিভাগে কোন লাইসেন্স প্রযোজ্য। স্বীকার করা, এটি একটি পার্শ্ব বোনাস।
- কোন প্রকল্পের ফাইল সম্পর্কে কাদের সাথে কথা বলবেন সে সম্পর্কে ধারণা পাওয়া।
- স্বয়ংক্রিয় টাস্কের তালিকা
এছাড়াও, একটি বোতামের স্পর্শে পয়েন্টি কেশিক মালিকদের খুশি রাখার মানটিকে অবমূল্যায়ন করবেন না।
সংক্ষেপে "অটো ডকুমেন্টেশন মন্তব্যগুলি" আমার কোডিং অভ্যাসের জন্য অতীব গুরুত্বপূর্ণ। আমি নিশ্চিত যে এমন অনেক লোক আছেন যারা লম্পট বলে মনে করেন তবে আমি ঠিক ঠিক নিশ্চিত যে এখানে বেশ কয়েকটি ন্যায্য লোক আছেন যারা জানেন আমি ঠিক কী বলছি। আমি জানি না যে আমি পিএইচপিএক্সআরএফ (এবং আমার প্রিয় আইডিই) আবিষ্কার করার আগে কীভাবে বেঁচে গিয়েছি।