[FFmpeg-user] "documented implicitly" [was: Re: Why is format=rgb24 required after maskedmerge?]

Mark Filipak markfilipak.windows+ffmpeg at gmail.com
Fri Aug 21 03:06:43 EEST 2020


On 08/20/2020 05:03 PM, Jim DeLaHunt wrote:
> On 2020-08-20 09:03, Alexander Strasser wrote:
> 
>> I will bring up a point that has become clear to me.
>>
>> Good documentation in general and especially for software is
>> incredibly hard to write and get right!
> 
> I very much agree: it is incredibly hard.

Sorry, Jim. But I have to disagree. It's "incredibly hard" for coders. It's not incredibly hard for 
technical writers. That's why coders shouldn't write documentation.

Coders should comment their code. Usually that will be a description of what they plan to do and 
why, written before they start writing lines of code. But from what I've seen, ffmpeg developers 
don't even put comments in their code. That's not only lazy, it's stupid.


More information about the ffmpeg-user mailing list