Am Notation

last modified: September 6, 2006

Class-, method-, and function- documentation comments, usually found in languages which accept a literal string indicating what something is like SmalltalkLanguage or CommonLisp, in the form:

I am a PHP lexical scanner.  Call GET-TOKEN on me to retrieve tokens until I return NIL.

I like this better than traditional third-person "This class scans PHP code. ..." I'm not sure why. --JasonFelice


Loading...